Interface CreateMessageRequestOrBuilder (0.19.0) 

public interface CreateMessageRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getMessage()

public abstract Message getMessage()

Required. Message body.

.google.chat.v1.Message message = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Message

The message.

getMessageId()

public abstract 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, but custom-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 abstract 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, but custom-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 abstract MessageOrBuilder getMessageOrBuilder()

Required. Message body.

.google.chat.v1.Message message = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
MessageOrBuilder

getMessageReplyOption()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.