Class UpdateSpaceRequest (0.11.0)

public final class UpdateSpaceRequest extends GeneratedMessageV3 implements UpdateSpaceRequestOrBuilder

A request to update a single space.

Protobuf type google.chat.v1.UpdateSpaceRequest

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

Static Methods

getDefaultInstance()

public static UpdateSpaceRequest getDefaultInstance()
Returns
Type Description
UpdateSpaceRequest

getDescriptor()

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

newBuilder()

public static UpdateSpaceRequest.Builder newBuilder()
Returns
Type Description
UpdateSpaceRequest.Builder

newBuilder(UpdateSpaceRequest prototype)

public static UpdateSpaceRequest.Builder newBuilder(UpdateSpaceRequest prototype)
Parameter
Name Description
prototype UpdateSpaceRequest
Returns
Type Description
UpdateSpaceRequest.Builder

parseDelimitedFrom(InputStream input)

public static UpdateSpaceRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UpdateSpaceRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateSpaceRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateSpaceRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static UpdateSpaceRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
UpdateSpaceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UpdateSpaceRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateSpaceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UpdateSpaceRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
UpdateSpaceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UpdateSpaceRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateSpaceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UpdateSpaceRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
UpdateSpaceRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateSpaceRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateSpaceRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static UpdateSpaceRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UpdateSpaceRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateSpaceRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateSpaceRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static UpdateSpaceRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
UpdateSpaceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UpdateSpaceRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateSpaceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<UpdateSpaceRequest> parser()
Returns
Type Description
Parser<UpdateSpaceRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public UpdateSpaceRequest getDefaultInstanceForType()
Returns
Type Description
UpdateSpaceRequest

getParserForType()

public Parser<UpdateSpaceRequest> getParserForType()
Returns
Type Description
Parser<UpdateSpaceRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

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;

Returns
Type Description
FieldMaskOrBuilder

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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public UpdateSpaceRequest.Builder newBuilderForType()
Returns
Type Description
UpdateSpaceRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UpdateSpaceRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
UpdateSpaceRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public UpdateSpaceRequest.Builder toBuilder()
Returns
Type Description
UpdateSpaceRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException