Class CreateMessageRequest (0.19.0)

public final class CreateMessageRequest extends GeneratedMessageV3 implements CreateMessageRequestOrBuilder

Creates a message.

Protobuf type google.chat.v1.CreateMessageRequest

Static Fields

MESSAGE_FIELD_NUMBER

public static final int MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

MESSAGE_ID_FIELD_NUMBER

public static final int MESSAGE_ID_FIELD_NUMBER
Field Value
Type Description
int

MESSAGE_REPLY_OPTION_FIELD_NUMBER

public static final int MESSAGE_REPLY_OPTION_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER
Field Value
Type Description
int

THREAD_KEY_FIELD_NUMBER

public static final int THREAD_KEY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateMessageRequest getDefaultInstance()
Returns
Type Description
CreateMessageRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CreateMessageRequest.Builder newBuilder()
Returns
Type Description
CreateMessageRequest.Builder

newBuilder(CreateMessageRequest prototype)

public static CreateMessageRequest.Builder newBuilder(CreateMessageRequest prototype)
Parameter
Name Description
prototype CreateMessageRequest
Returns
Type Description
CreateMessageRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateMessageRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateMessageRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateMessageRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateMessageRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreateMessageRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreateMessageRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateMessageRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateMessageRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateMessageRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreateMessageRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateMessageRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateMessageRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateMessageRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreateMessageRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateMessageRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateMessageRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreateMessageRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateMessageRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateMessageRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateMessageRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreateMessageRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreateMessageRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateMessageRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateMessageRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreateMessageRequest> parser()
Returns
Type Description
Parser<CreateMessageRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CreateMessageRequest getDefaultInstanceForType()
Returns
Type Description
CreateMessageRequest

getMessage()

public Message getMessage()

Required. Message body.

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

Returns
Type Description
Message

The message.

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, 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 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 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.

getParserForType()

public Parser<CreateMessageRequest> getParserForType()
Returns
Type Description
Parser<CreateMessageRequest>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreateMessageRequest.Builder newBuilderForType()
Returns
Type Description
CreateMessageRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateMessageRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreateMessageRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreateMessageRequest.Builder toBuilder()
Returns
Type Description
CreateMessageRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException