public static final class CreateMessageRequest.Builder extends GeneratedMessageV3.Builder<CreateMessageRequest.Builder> implements CreateMessageRequestOrBuilder
Creates a message.
Protobuf type google.chat.v1.CreateMessageRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CreateMessageRequest.BuilderImplements
CreateMessageRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CreateMessageRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
build()
public CreateMessageRequest build()
Returns | |
---|---|
Type | Description |
CreateMessageRequest |
buildPartial()
public CreateMessageRequest buildPartial()
Returns | |
---|---|
Type | Description |
CreateMessageRequest |
clear()
public CreateMessageRequest.Builder clear()
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public CreateMessageRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
clearMessage()
public CreateMessageRequest.Builder clearMessage()
Required. Message body.
.google.chat.v1.Message message = 4 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
clearMessageId()
public CreateMessageRequest.Builder clearMessageId()
Optional. A custom ID for a message. Lets Chat apps get, update, or delete
a message without needing to store the system-assigned ID in the message's
resource name (represented in the message name
field).
The value for this field must meet the following requirements:
- Begins with
client-
. For example,client-custom-name
is a valid custom ID, butcustom-name
is not. - Contains up to 63 characters and only lowercase letters, numbers, and hyphens.
Is unique within a space. A Chat app can't use the same custom ID for different messages.
For details, see Name a message.
string message_id = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
This builder for chaining. |
clearMessageReplyOption()
public CreateMessageRequest.Builder clearMessageReplyOption()
Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces.
When responding to user interactions, this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread.
.google.chat.v1.CreateMessageRequest.MessageReplyOption message_reply_option = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public CreateMessageRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
clearParent()
public CreateMessageRequest.Builder clearParent()
Required. The resource name of the space in which to create a message.
Format: spaces/{space}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
This builder for chaining. |
clearRequestId()
public CreateMessageRequest.Builder clearRequestId()
Optional. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message.
string request_id = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
This builder for chaining. |
clearThreadKey() (deprecated)
public CreateMessageRequest.Builder clearThreadKey()
Deprecated. google.chat.v1.CreateMessageRequest.thread_key is deprecated. See google/chat/v1/message.proto;l=510
Optional. Deprecated: Use
thread.thread_key instead. ID for the
thread. Supports up to 4000 characters. To start or add to a thread, create
a message and specify a threadKey
or the
thread.name. For example usage, see Start or
reply to a message
thread.
string thread_key = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
This builder for chaining. |
clone()
public CreateMessageRequest.Builder clone()
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
getDefaultInstanceForType()
public CreateMessageRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
CreateMessageRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getMessage()
public Message getMessage()
Required. Message body.
.google.chat.v1.Message message = 4 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Message |
The message. |
getMessageBuilder()
public Message.Builder getMessageBuilder()
Required. Message body.
.google.chat.v1.Message message = 4 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Message.Builder |
getMessageId()
public String getMessageId()
Optional. A custom ID for a message. Lets Chat apps get, update, or delete
a message without needing to store the system-assigned ID in the message's
resource name (represented in the message name
field).
The value for this field must meet the following requirements:
- Begins with
client-
. For example,client-custom-name
is a valid custom ID, butcustom-name
is not. - Contains up to 63 characters and only lowercase letters, numbers, and hyphens.
Is unique within a space. A Chat app can't use the same custom ID for different messages.
For details, see Name a message.
string message_id = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String |
The messageId. |
getMessageIdBytes()
public ByteString getMessageIdBytes()
Optional. A custom ID for a message. Lets Chat apps get, update, or delete
a message without needing to store the system-assigned ID in the message's
resource name (represented in the message name
field).
The value for this field must meet the following requirements:
- Begins with
client-
. For example,client-custom-name
is a valid custom ID, butcustom-name
is not. - Contains up to 63 characters and only lowercase letters, numbers, and hyphens.
Is unique within a space. A Chat app can't use the same custom ID for different messages.
For details, see Name a message.
string message_id = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for messageId. |
getMessageOrBuilder()
public MessageOrBuilder getMessageOrBuilder()
Required. Message body.
.google.chat.v1.Message message = 4 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
MessageOrBuilder |
getMessageReplyOption()
public CreateMessageRequest.MessageReplyOption getMessageReplyOption()
Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces.
When responding to user interactions, this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread.
.google.chat.v1.CreateMessageRequest.MessageReplyOption message_reply_option = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
CreateMessageRequest.MessageReplyOption |
The messageReplyOption. |
getMessageReplyOptionValue()
public int getMessageReplyOptionValue()
Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces.
When responding to user interactions, this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread.
.google.chat.v1.CreateMessageRequest.MessageReplyOption message_reply_option = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for messageReplyOption. |
getParent()
public String getParent()
Required. The resource name of the space in which to create a message.
Format: spaces/{space}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String |
The parent. |
getParentBytes()
public ByteString getParentBytes()
Required. The resource name of the space in which to create a message.
Format: spaces/{space}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for parent. |
getRequestId()
public String getRequestId()
Optional. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message.
string request_id = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String |
The requestId. |
getRequestIdBytes()
public ByteString getRequestIdBytes()
Optional. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message.
string request_id = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for requestId. |
getThreadKey() (deprecated)
public String getThreadKey()
Deprecated. google.chat.v1.CreateMessageRequest.thread_key is deprecated. See google/chat/v1/message.proto;l=510
Optional. Deprecated: Use
thread.thread_key instead. ID for the
thread. Supports up to 4000 characters. To start or add to a thread, create
a message and specify a threadKey
or the
thread.name. For example usage, see Start or
reply to a message
thread.
string thread_key = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String |
The threadKey. |
getThreadKeyBytes() (deprecated)
public ByteString getThreadKeyBytes()
Deprecated. google.chat.v1.CreateMessageRequest.thread_key is deprecated. See google/chat/v1/message.proto;l=510
Optional. Deprecated: Use
thread.thread_key instead. ID for the
thread. Supports up to 4000 characters. To start or add to a thread, create
a message and specify a threadKey
or the
thread.name. For example usage, see Start or
reply to a message
thread.
string thread_key = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for threadKey. |
hasMessage()
public boolean hasMessage()
Required. Message body.
.google.chat.v1.Message message = 4 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
boolean |
Whether the message field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(CreateMessageRequest other)
public CreateMessageRequest.Builder mergeFrom(CreateMessageRequest other)
Parameter | |
---|---|
Name | Description |
other |
CreateMessageRequest |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CreateMessageRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public CreateMessageRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
mergeMessage(Message value)
public CreateMessageRequest.Builder mergeMessage(Message value)
Required. Message body.
.google.chat.v1.Message message = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
Message |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CreateMessageRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public CreateMessageRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
setMessage(Message value)
public CreateMessageRequest.Builder setMessage(Message value)
Required. Message body.
.google.chat.v1.Message message = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
Message |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
setMessage(Message.Builder builderForValue)
public CreateMessageRequest.Builder setMessage(Message.Builder builderForValue)
Required. Message body.
.google.chat.v1.Message message = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
builderForValue |
Message.Builder |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
setMessageId(String value)
public CreateMessageRequest.Builder setMessageId(String value)
Optional. A custom ID for a message. Lets Chat apps get, update, or delete
a message without needing to store the system-assigned ID in the message's
resource name (represented in the message name
field).
The value for this field must meet the following requirements:
- Begins with
client-
. For example,client-custom-name
is a valid custom ID, butcustom-name
is not. - Contains up to 63 characters and only lowercase letters, numbers, and hyphens.
Is unique within a space. A Chat app can't use the same custom ID for different messages.
For details, see Name a message.
string message_id = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The messageId to set. |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
This builder for chaining. |
setMessageIdBytes(ByteString value)
public CreateMessageRequest.Builder setMessageIdBytes(ByteString value)
Optional. A custom ID for a message. Lets Chat apps get, update, or delete
a message without needing to store the system-assigned ID in the message's
resource name (represented in the message name
field).
The value for this field must meet the following requirements:
- Begins with
client-
. For example,client-custom-name
is a valid custom ID, butcustom-name
is not. - Contains up to 63 characters and only lowercase letters, numbers, and hyphens.
Is unique within a space. A Chat app can't use the same custom ID for different messages.
For details, see Name a message.
string message_id = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for messageId to set. |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
This builder for chaining. |
setMessageReplyOption(CreateMessageRequest.MessageReplyOption value)
public CreateMessageRequest.Builder setMessageReplyOption(CreateMessageRequest.MessageReplyOption value)
Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces.
When responding to user interactions, this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread.
.google.chat.v1.CreateMessageRequest.MessageReplyOption message_reply_option = 8 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
CreateMessageRequest.MessageReplyOption The messageReplyOption to set. |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
This builder for chaining. |
setMessageReplyOptionValue(int value)
public CreateMessageRequest.Builder setMessageReplyOptionValue(int value)
Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces.
When responding to user interactions, this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread.
.google.chat.v1.CreateMessageRequest.MessageReplyOption message_reply_option = 8 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
int The enum numeric value on the wire for messageReplyOption to set. |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
This builder for chaining. |
setParent(String value)
public CreateMessageRequest.Builder setParent(String value)
Required. The resource name of the space in which to create a message.
Format: spaces/{space}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The parent to set. |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public CreateMessageRequest.Builder setParentBytes(ByteString value)
Required. The resource name of the space in which to create a message.
Format: spaces/{space}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for parent to set. |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CreateMessageRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
setRequestId(String value)
public CreateMessageRequest.Builder setRequestId(String value)
Optional. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message.
string request_id = 7 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The requestId to set. |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
This builder for chaining. |
setRequestIdBytes(ByteString value)
public CreateMessageRequest.Builder setRequestIdBytes(ByteString value)
Optional. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message.
string request_id = 7 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for requestId to set. |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
This builder for chaining. |
setThreadKey(String value) (deprecated)
public CreateMessageRequest.Builder setThreadKey(String value)
Deprecated. google.chat.v1.CreateMessageRequest.thread_key is deprecated. See google/chat/v1/message.proto;l=510
Optional. Deprecated: Use
thread.thread_key instead. ID for the
thread. Supports up to 4000 characters. To start or add to a thread, create
a message and specify a threadKey
or the
thread.name. For example usage, see Start or
reply to a message
thread.
string thread_key = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The threadKey to set. |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
This builder for chaining. |
setThreadKeyBytes(ByteString value) (deprecated)
public CreateMessageRequest.Builder setThreadKeyBytes(ByteString value)
Deprecated. google.chat.v1.CreateMessageRequest.thread_key is deprecated. See google/chat/v1/message.proto;l=510
Optional. Deprecated: Use
thread.thread_key instead. ID for the
thread. Supports up to 4000 characters. To start or add to a thread, create
a message and specify a threadKey
or the
thread.name. For example usage, see Start or
reply to a message
thread.
string thread_key = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for threadKey to set. |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final CreateMessageRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
CreateMessageRequest.Builder |