Google Chat V1 API - Class Google::Apps::Chat::V1::CreateSpaceRequest (v0.31.0)

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

A request to create a named space with no members.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#request_id

def request_id() -> ::String
Returns
  • (::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.

#request_id=

def request_id=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#space

def space() -> ::Google::Apps::Chat::V1::Space
Returns
  • (::Google::Apps::Chat::V1::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.

#space=

def space=(value) -> ::Google::Apps::Chat::V1::Space
Parameter
  • value (::Google::Apps::Chat::V1::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
  • (::Google::Apps::Chat::V1::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.