public interface SetUpSpaceRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getMemberships(int index)
public abstract Membership getMemberships(int index)Optional. The Google Chat users to invite to join the space. Omit the calling user, as they are added automatically.
The set currently allows up to 20 memberships (in addition to the caller).
For human membership, the Membership.member field must contain a user
with name populated (format: users/{user}) and type set to
User.Type.HUMAN. You can only add human users when setting up a space
(adding Chat apps is only supported for direct message setup with the
calling app). You can also add members using the user's email as an alias
for {user}. For example, the user.name can be users/example@gmail.com.
To invite Gmail users or users from external Google Workspace domains,
user's email must be used for {user}.
Optional when setting Space.spaceType to SPACE.
Required when setting Space.spaceType to GROUP_CHAT, along with at
least two memberships.
Required when setting Space.spaceType to DIRECT_MESSAGE with a human
user, along with exactly one membership.
Must be empty when creating a 1:1 conversation between a human and the
calling Chat app (when setting Space.spaceType to
DIRECT_MESSAGE and Space.singleUserBotDm to true).
repeated .google.chat.v1.Membership memberships = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Membership |
|
getMembershipsCount()
public abstract int getMembershipsCount()Optional. The Google Chat users to invite to join the space. Omit the calling user, as they are added automatically.
The set currently allows up to 20 memberships (in addition to the caller).
For human membership, the Membership.member field must contain a user
with name populated (format: users/{user}) and type set to
User.Type.HUMAN. You can only add human users when setting up a space
(adding Chat apps is only supported for direct message setup with the
calling app). You can also add members using the user's email as an alias
for {user}. For example, the user.name can be users/example@gmail.com.
To invite Gmail users or users from external Google Workspace domains,
user's email must be used for {user}.
Optional when setting Space.spaceType to SPACE.
Required when setting Space.spaceType to GROUP_CHAT, along with at
least two memberships.
Required when setting Space.spaceType to DIRECT_MESSAGE with a human
user, along with exactly one membership.
Must be empty when creating a 1:1 conversation between a human and the
calling Chat app (when setting Space.spaceType to
DIRECT_MESSAGE and Space.singleUserBotDm to true).
repeated .google.chat.v1.Membership memberships = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getMembershipsList()
public abstract List<Membership> getMembershipsList()Optional. The Google Chat users to invite to join the space. Omit the calling user, as they are added automatically.
The set currently allows up to 20 memberships (in addition to the caller).
For human membership, the Membership.member field must contain a user
with name populated (format: users/{user}) and type set to
User.Type.HUMAN. You can only add human users when setting up a space
(adding Chat apps is only supported for direct message setup with the
calling app). You can also add members using the user's email as an alias
for {user}. For example, the user.name can be users/example@gmail.com.
To invite Gmail users or users from external Google Workspace domains,
user's email must be used for {user}.
Optional when setting Space.spaceType to SPACE.
Required when setting Space.spaceType to GROUP_CHAT, along with at
least two memberships.
Required when setting Space.spaceType to DIRECT_MESSAGE with a human
user, along with exactly one membership.
Must be empty when creating a 1:1 conversation between a human and the
calling Chat app (when setting Space.spaceType to
DIRECT_MESSAGE and Space.singleUserBotDm to true).
repeated .google.chat.v1.Membership memberships = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Membership> |
|
getMembershipsOrBuilder(int index)
public abstract MembershipOrBuilder getMembershipsOrBuilder(int index)Optional. The Google Chat users to invite to join the space. Omit the calling user, as they are added automatically.
The set currently allows up to 20 memberships (in addition to the caller).
For human membership, the Membership.member field must contain a user
with name populated (format: users/{user}) and type set to
User.Type.HUMAN. You can only add human users when setting up a space
(adding Chat apps is only supported for direct message setup with the
calling app). You can also add members using the user's email as an alias
for {user}. For example, the user.name can be users/example@gmail.com.
To invite Gmail users or users from external Google Workspace domains,
user's email must be used for {user}.
Optional when setting Space.spaceType to SPACE.
Required when setting Space.spaceType to GROUP_CHAT, along with at
least two memberships.
Required when setting Space.spaceType to DIRECT_MESSAGE with a human
user, along with exactly one membership.
Must be empty when creating a 1:1 conversation between a human and the
calling Chat app (when setting Space.spaceType to
DIRECT_MESSAGE and Space.singleUserBotDm to true).
repeated .google.chat.v1.Membership memberships = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
MembershipOrBuilder |
|
getMembershipsOrBuilderList()
public abstract List<? extends MembershipOrBuilder> getMembershipsOrBuilderList()Optional. The Google Chat users to invite to join the space. Omit the calling user, as they are added automatically.
The set currently allows up to 20 memberships (in addition to the caller).
For human membership, the Membership.member field must contain a user
with name populated (format: users/{user}) and type set to
User.Type.HUMAN. You can only add human users when setting up a space
(adding Chat apps is only supported for direct message setup with the
calling app). You can also add members using the user's email as an alias
for {user}. For example, the user.name can be users/example@gmail.com.
To invite Gmail users or users from external Google Workspace domains,
user's email must be used for {user}.
Optional when setting Space.spaceType to SPACE.
Required when setting Space.spaceType to GROUP_CHAT, along with at
least two memberships.
Required when setting Space.spaceType to DIRECT_MESSAGE with a human
user, along with exactly one membership.
Must be empty when creating a 1:1 conversation between a human and the
calling Chat app (when setting Space.spaceType to
DIRECT_MESSAGE and Space.singleUserBotDm to true).
repeated .google.chat.v1.Membership memberships = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.chat.v1.MembershipOrBuilder> |
|
getRequestId()
public abstract String getRequestId()Optional. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error.
string request_id = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The requestId. |
getRequestIdBytes()
public abstract ByteString getRequestIdBytes()Optional. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error.
string request_id = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for requestId. |
getSpace()
public abstract Space getSpace() Required. The Space.spaceType field is required.
To create a space, set Space.spaceType to SPACE and set
Space.displayName. If you receive the error message ALREADY_EXISTS when
setting up a space, try a different displayName. An existing space
within the Google Workspace organization might already use this display
name.
To create a group chat, set Space.spaceType to
GROUP_CHAT. Don't set Space.displayName.
To create a 1:1 conversation between humans,
set Space.spaceType to DIRECT_MESSAGE and set
Space.singleUserBotDm to false. Don't set Space.displayName or
Space.spaceDetails.
To create an 1:1 conversation between a human and the calling Chat app, set
Space.spaceType to DIRECT_MESSAGE and
Space.singleUserBotDm to true. Don't set Space.displayName or
Space.spaceDetails.
If a DIRECT_MESSAGE space already exists, that space is returned instead
of creating a new space.
.google.chat.v1.Space space = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Space |
The space. |
getSpaceOrBuilder()
public abstract SpaceOrBuilder getSpaceOrBuilder() Required. The Space.spaceType field is required.
To create a space, set Space.spaceType to SPACE and set
Space.displayName. If you receive the error message ALREADY_EXISTS when
setting up a space, try a different displayName. An existing space
within the Google Workspace organization might already use this display
name.
To create a group chat, set Space.spaceType to
GROUP_CHAT. Don't set Space.displayName.
To create a 1:1 conversation between humans,
set Space.spaceType to DIRECT_MESSAGE and set
Space.singleUserBotDm to false. Don't set Space.displayName or
Space.spaceDetails.
To create an 1:1 conversation between a human and the calling Chat app, set
Space.spaceType to DIRECT_MESSAGE and
Space.singleUserBotDm to true. Don't set Space.displayName or
Space.spaceDetails.
If a DIRECT_MESSAGE space already exists, that space is returned instead
of creating a new space.
.google.chat.v1.Space space = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
SpaceOrBuilder |
|
hasSpace()
public abstract boolean hasSpace() Required. The Space.spaceType field is required.
To create a space, set Space.spaceType to SPACE and set
Space.displayName. If you receive the error message ALREADY_EXISTS when
setting up a space, try a different displayName. An existing space
within the Google Workspace organization might already use this display
name.
To create a group chat, set Space.spaceType to
GROUP_CHAT. Don't set Space.displayName.
To create a 1:1 conversation between humans,
set Space.spaceType to DIRECT_MESSAGE and set
Space.singleUserBotDm to false. Don't set Space.displayName or
Space.spaceDetails.
To create an 1:1 conversation between a human and the calling Chat app, set
Space.spaceType to DIRECT_MESSAGE and
Space.singleUserBotDm to true. Don't set Space.displayName or
Space.spaceDetails.
If a DIRECT_MESSAGE space already exists, that space is returned instead
of creating a new space.
.google.chat.v1.Space space = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the space field is set. |