Class UpdateSpaceRequest.Builder (0.10.0)

public static final class UpdateSpaceRequest.Builder extends GeneratedMessageV3.Builder<UpdateSpaceRequest.Builder> implements UpdateSpaceRequestOrBuilder

A request to update a single space.

Protobuf type google.chat.v1.UpdateSpaceRequest

Static 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
Overrides

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
Overrides

clearField(Descriptors.FieldDescriptor field)

public UpdateSpaceRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UpdateSpaceRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateSpaceRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UpdateSpaceRequest.Builder
Overrides

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.

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_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.)

  • Developer Preview: access_settings.audience (Supports changing the access setting of a space. If no audience is specified in the access setting, the space's access setting is updated to restricted. Warning: mutually exclusive with all other field paths.)

.google.protobuf.FieldMask update_mask = 2;

Returns
Type Description
UpdateSpaceRequest.Builder

clone()

public UpdateSpaceRequest.Builder clone()
Returns
Type Description
UpdateSpaceRequest.Builder
Overrides

getDefaultInstanceForType()

public UpdateSpaceRequest getDefaultInstanceForType()
Returns
Type Description
UpdateSpaceRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

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.

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_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.)

  • Developer Preview: access_settings.audience (Supports changing the access setting of a space. If no audience is specified in the access setting, the space's access setting is updated to restricted. Warning: mutually exclusive with all other field paths.)

.google.protobuf.FieldMask update_mask = 2;

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

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_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.)

  • Developer Preview: access_settings.audience (Supports changing the access setting of a space. If no audience is specified in the access setting, the space's access setting is updated to restricted. Warning: mutually exclusive with all other field paths.)

.google.protobuf.FieldMask update_mask = 2;

Returns
Type Description
Builder

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_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.)

  • Developer Preview: access_settings.audience (Supports changing the access setting of a space. If no audience is specified in the access setting, the space's access setting is updated to restricted. Warning: mutually exclusive with all other field paths.)

.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_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.)

  • Developer Preview: access_settings.audience (Supports changing the access setting of a space. If no audience is specified in the access setting, the space's access setting is updated to restricted. Warning: mutually exclusive with all other field paths.)

.google.protobuf.FieldMask update_mask = 2;

Returns
Type Description
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UpdateSpaceRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UpdateSpaceRequest.Builder
Overrides

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
Overrides

mergeUpdateMask(FieldMask value)

public UpdateSpaceRequest.Builder mergeUpdateMask(FieldMask value)

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_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.)

  • Developer Preview: access_settings.audience (Supports changing the access setting of a space. If no audience is specified in the access setting, the space's access setting is updated to restricted. Warning: mutually exclusive with all other field paths.)

.google.protobuf.FieldMask update_mask = 2;

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
Overrides

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
Overrides

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
Overrides

setUpdateMask(FieldMask value)

public UpdateSpaceRequest.Builder setUpdateMask(FieldMask value)

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_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.)

  • Developer Preview: access_settings.audience (Supports changing the access setting of a space. If no audience is specified in the access setting, the space's access setting is updated to restricted. Warning: mutually exclusive with all other field paths.)

.google.protobuf.FieldMask update_mask = 2;

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.

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_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.)

  • Developer Preview: access_settings.audience (Supports changing the access setting of a space. If no audience is specified in the access setting, the space's access setting is updated to restricted. Warning: mutually exclusive with all other field paths.)

.google.protobuf.FieldMask update_mask = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UpdateSpaceRequest.Builder