Google Apps Chat V1 Client - Class CreateSpaceRequest (0.28.0)

Reference documentation and code samples for the Google Apps Chat V1 Client class CreateSpaceRequest.

A request to create a named space with no members.

Generated from protobuf message google.chat.v1.CreateSpaceRequest

Namespace

Google \ Apps \ Chat \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ space Space

Required. The displayName and spaceType fields must be populated. Only SpaceType.SPACE and SpaceType.GROUP_CHAT are supported. SpaceType.GROUP_CHAT can only be used if importMode is set to true. If you receive the error message ALREADY_EXISTS, try a different displayName. An existing space within the Google Workspace organization might already use this display name. The space name is assigned on the server so anything specified in this field will be ignored.
↳ request_id string

Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single space being created. Subsequent requests with the same request ID return the existing space and do not update the space, even if the requested details differ from the current state. To use this field effectively: - Ensure that subsequent requests are identical and use the same authentication credentials as the original request. - If a space was already created with the provided request ID, the request returns that space. Note that the returned space might not be fully populated; the API echoes the space in your request with the system-assigned resource name populated. To retrieve the latest metadata for the space, call GetSpace. - Reusing an existing request ID with a different authenticated user results in an error.

getSpace

Required. The displayName and spaceType fields must be populated. Only SpaceType.SPACE and SpaceType.GROUP_CHAT are supported.

SpaceType.GROUP_CHAT can only be used if importMode is set to true. If you receive the error message ALREADY_EXISTS, try a different displayName. An existing space within the Google Workspace organization might already use this display name. The space name is assigned on the server so anything specified in this field will be ignored.

Returns
Type Description
Space|null

hasSpace

clearSpace

setSpace

Required. The displayName and spaceType fields must be populated. Only SpaceType.SPACE and SpaceType.GROUP_CHAT are supported.

SpaceType.GROUP_CHAT can only be used if importMode is set to true. If you receive the error message ALREADY_EXISTS, try a different displayName. An existing space within the Google Workspace organization might already use this display name. The space name is assigned on the server so anything specified in this field will be ignored.

Parameter
Name Description
var Space
Returns
Type Description
$this

getRequestId

Optional. A unique ID for this request. A random UUID is recommended.

Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single space being created. Subsequent requests with the same request ID return the existing space and do not update the space, even if the requested details differ from the current state. To use this field effectively:

  • Ensure that subsequent requests are identical and use the same authentication credentials as the original request.
  • If a space was already created with the provided request ID, the request returns that space. Note that the returned space might not be fully populated; the API echoes the space in your request with the system-assigned resource name populated. To retrieve the latest metadata for the space, call GetSpace.
  • Reusing an existing request ID with a different authenticated user results in an error.
Returns
Type Description
string

setRequestId

Optional. A unique ID for this request. A random UUID is recommended.

Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single space being created. Subsequent requests with the same request ID return the existing space and do not update the space, even if the requested details differ from the current state. To use this field effectively:

  • Ensure that subsequent requests are identical and use the same authentication credentials as the original request.
  • If a space was already created with the provided request ID, the request returns that space. Note that the returned space might not be fully populated; the API echoes the space in your request with the system-assigned resource name populated. To retrieve the latest metadata for the space, call GetSpace.
  • Reusing an existing request ID with a different authenticated user results in an error.
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
space Space

Required. The displayName and spaceType fields must be populated. Only SpaceType.SPACE and SpaceType.GROUP_CHAT are supported. SpaceType.GROUP_CHAT can only be used if importMode is set to true.

If you receive the error message ALREADY_EXISTS, try a different displayName. An existing space within the Google Workspace organization might already use this display name.

The space name is assigned on the server so anything specified in this field will be ignored.
Returns
Type Description
CreateSpaceRequest