public final class SetUpSpaceRequest extends GeneratedMessageV3 implements SetUpSpaceRequestOrBuilderRequest to create a space and add specified users to it.
Protobuf type google.chat.v1.SetUpSpaceRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SetUpSpaceRequestImplements
SetUpSpaceRequestOrBuilderStatic Fields
MEMBERSHIPS_FIELD_NUMBER
public static final int MEMBERSHIPS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
REQUEST_ID_FIELD_NUMBER
public static final int REQUEST_ID_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SPACE_FIELD_NUMBER
public static final int SPACE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static SetUpSpaceRequest getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
SetUpSpaceRequest |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static SetUpSpaceRequest.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
SetUpSpaceRequest.Builder |
|
newBuilder(SetUpSpaceRequest prototype)
public static SetUpSpaceRequest.Builder newBuilder(SetUpSpaceRequest prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
SetUpSpaceRequest |
| Returns | |
|---|---|
| Type | Description |
SetUpSpaceRequest.Builder |
|
parseDelimitedFrom(InputStream input)
public static SetUpSpaceRequest parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
SetUpSpaceRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SetUpSpaceRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SetUpSpaceRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static SetUpSpaceRequest parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
SetUpSpaceRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SetUpSpaceRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SetUpSpaceRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static SetUpSpaceRequest parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
SetUpSpaceRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SetUpSpaceRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SetUpSpaceRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static SetUpSpaceRequest parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
SetUpSpaceRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SetUpSpaceRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SetUpSpaceRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static SetUpSpaceRequest parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
SetUpSpaceRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SetUpSpaceRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SetUpSpaceRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static SetUpSpaceRequest parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
SetUpSpaceRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SetUpSpaceRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SetUpSpaceRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<SetUpSpaceRequest> parser()| Returns | |
|---|---|
| Type | Description |
Parser<SetUpSpaceRequest> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public SetUpSpaceRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SetUpSpaceRequest |
|
getMemberships(int index)
public Membership getMemberships(int index)Optional. The Google Chat users or groups 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}.
For Google group membership, the Membership.group_member field must
contain a group with name populated (format groups/{group}). You
can only add Google groups when setting Space.spaceType to SPACE.
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 int getMembershipsCount()Optional. The Google Chat users or groups 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}.
For Google group membership, the Membership.group_member field must
contain a group with name populated (format groups/{group}). You
can only add Google groups when setting Space.spaceType to SPACE.
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 List<Membership> getMembershipsList()Optional. The Google Chat users or groups 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}.
For Google group membership, the Membership.group_member field must
contain a group with name populated (format groups/{group}). You
can only add Google groups when setting Space.spaceType to SPACE.
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 MembershipOrBuilder getMembershipsOrBuilder(int index)Optional. The Google Chat users or groups 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}.
For Google group membership, the Membership.group_member field must
contain a group with name populated (format groups/{group}). You
can only add Google groups when setting Space.spaceType to SPACE.
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 List<? extends MembershipOrBuilder> getMembershipsOrBuilderList()Optional. The Google Chat users or groups 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}.
For Google group membership, the Membership.group_member field must
contain a group with name populated (format groups/{group}). You
can only add Google groups when setting Space.spaceType to SPACE.
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> |
|
getParserForType()
public Parser<SetUpSpaceRequest> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<SetUpSpaceRequest> |
|
getRequestId()
public 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 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. |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
getSpace()
public 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 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 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. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public SetUpSpaceRequest.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
SetUpSpaceRequest.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SetUpSpaceRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
SetUpSpaceRequest.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public SetUpSpaceRequest.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
SetUpSpaceRequest.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|