Class: Google::Apis::CloudsearchV1::Message

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudsearch_v1/classes.rb,
lib/google/apis/cloudsearch_v1/representations.rb,
lib/google/apis/cloudsearch_v1/representations.rb

Overview

Message posted to a Space.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Message

Returns a new instance of Message.



14138
14139
14140
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14138

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#annotations ⇒ Array<Google::Apis::CloudsearchV1::Annotation>

Annotations parsed and extracted from the text body. Corresponds to the JSON property annotations

Returns:



13853
13854
13855
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13853

def annotations
  @annotations
end

#app_profile ⇒ Google::Apis::CloudsearchV1::AppsDynamiteSharedAppProfile

Optional field for apps overriding display info Corresponds to the JSON property appProfile

Returns:



13858
13859
13860
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13858

def app_profile
  @app_profile
end

#attachments ⇒ Array<Google::Apis::CloudsearchV1::Attachment>

Attachments parsed from incoming webhooks Corresponds to the JSON property attachments

Returns:



13863
13864
13865
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13863

def attachments
  @attachments
end

#attributes ⇒ Google::Apis::CloudsearchV1::MessageAttributes

Stores tombstone message attributes: go/tombstone-message-attributes-overview Corresponds to the JSON property attributes

Returns:



13868
13869
13870
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13868

def attributes
  @attributes
end

#bot_responses ⇒ Array<Google::Apis::CloudsearchV1::BotResponse>

Responses from bots indicating if extra auth/config is needed. Corresponds to the JSON property botResponses

Returns:



13873
13874
13875
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13873

def bot_responses
  @bot_responses
end

#communal_labels ⇒ Array<Google::Apis::CloudsearchV1::CommunalLabelTag>

Communal labels associated with a message. These exist on the message itself regardless of which user fetches them. Order of entries is arbitrary and will not list duplicates of the same label_id. See go/chat-labels-design for details. Corresponds to the JSON property communalLabels

Returns:



13881
13882
13883
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13881

def communal_labels
  @communal_labels
end

#content_report_summary ⇒ Google::Apis::CloudsearchV1::ContentReportSummary

Summarized info of content reports. Usually less expensive to fetch than to fetch all detailed reports. Set only when the request asks for it. Corresponds to the JSON property contentReportSummary

Returns:



13887
13888
13889
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13887

def content_report_summary
  @content_report_summary
end

#create_time ⇒ Fixnum

Time when the Message was posted in microseconds. Corresponds to the JSON property createTime

Returns:

  • (Fixnum) 


13892
13893
13894
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13892

def create_time
  @create_time
end

#creator_id ⇒ Google::Apis::CloudsearchV1::UserId

Primary key for User resource. Corresponds to the JSON property creatorId

Returns:



13897
13898
13899
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13897

def creator_id
  @creator_id
end

#deletable_by ⇒ String

Indicates who can delete the message. This field is set on the read path (e.g. ListTopics) but doesn’t have any effect on the write path (e.g. CreateMessageRequest). Corresponds to the JSON property deletableBy

Returns:

  • (String) 


13904
13905
13906
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13904

def deletable_by
  @deletable_by
end

#delete_time ⇒ Fixnum

Time when the Message was deleted in microseconds. This field is set to nonzero value only for Messages deleted globally. Corresponds to the JSON property deleteTime

Returns:

  • (Fixnum) 


13910
13911
13912
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13910

def delete_time
  @delete_time
end

#delete_time_for_requester ⇒ Fixnum

Time when the Message was per-user deleted by the message requester in microseconds. This field is set to nonzero value only for Message per-user deleted by the requester. Corresponds to the JSON property deleteTimeForRequester

Returns:

  • (Fixnum) 


13917
13918
13919
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13917

def delete_time_for_requester
  @delete_time_for_requester
end

#deleted_by_vault ⇒ Boolean Also known as: deleted_by_vault?

Was this message deleted by Vault (Only used for Vault support) This is false if message is live or message was deleted by user. Corresponds to the JSON property deletedByVault

Returns:

  • (Boolean) 


13923
13924
13925
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13923

def deleted_by_vault
  @deleted_by_vault
end

#dlp_scan_summary ⇒ Google::Apis::CloudsearchV1::DlpScanSummary

A summary of a DLP scan event. This is a summary and should contain the minimum amount of data required to identify and process DLP scans. It is written to Starcast and encoded & returned to the client on attachment upload. Corresponds to the JSON property dlpScanSummary

Returns:



13931
13932
13933
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13931

def dlp_scan_summary
  @dlp_scan_summary
end

#editable_by ⇒ String

Indicates who can edit the message. This field is set on the read path (e.g. ListTopics) but doesn’t have any effect on the write path (e.g. CreateMessageRequest). Corresponds to the JSON property editableBy

Returns:

  • (String) 


13938
13939
13940
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13938

def editable_by
  @editable_by
end

#fallback_text ⇒ String

A plain-text description of the attachment, used when clients cannot display formatted attachment (e.g. mobile push notifications). Corresponds to the JSON property fallbackText

Returns:

  • (String) 


13944
13945
13946
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13944

def fallback_text
  @fallback_text
end

#id ⇒ Google::Apis::CloudsearchV1::MessageId

Primary key for Message resource. Corresponds to the JSON property id

Returns:



13949
13950
13951
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13949

def id
  @id
end

#is_content_purged ⇒ Boolean Also known as: is_content_purged?

Whether the message is content purged. Content purged messages contain only data required for tombstone (see go/chat-infinite-tombstone). This field is only used by Vault to display tombstone and should only be set to true if the message is a tombstone. Corresponds to the JSON property isContentPurged

Returns:

  • (Boolean) 


13957
13958
13959
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13957

def is_content_purged
  @is_content_purged
end

#is_inline_reply ⇒ Boolean Also known as: is_inline_reply?

Output only. Indicates if the message is an inline reply. Set to true only if the message's ParentPath is non-NULL. Currently, only inline replies have non- NULL ParentPath. See go/chat-be-inline-reply-indicator. Corresponds to the JSON property isInlineReply

Returns:

  • (Boolean) 


13965
13966
13967
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13965

def is_inline_reply
  @is_inline_reply
end

#last_edit_time ⇒ Fixnum

If the message was edited by a user, timestamp of the last edit, in microseconds. Corresponds to the JSON property lastEditTime

Returns:

  • (Fixnum) 


13972
13973
13974
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13972

def last_edit_time
  @last_edit_time
end

#last_update_time ⇒ Fixnum

Time when the Message text was last updated in microseconds. Corresponds to the JSON property lastUpdateTime

Returns:

  • (Fixnum) 


13977
13978
13979
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13977

def last_update_time
  @last_update_time
end

#local_id ⇒ String

A unique id specified on the client side. Corresponds to the JSON property localId

Returns:

  • (String) 


13982
13983
13984
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13982

def local_id
  @local_id
end

#message_integration_payload ⇒ Google::Apis::CloudsearchV1::AppsDynamiteSharedMessageIntegrationPayload

The payload(restricted to 1P applications) to be stored with a specific message. Corresponds to the JSON property messageIntegrationPayload

Returns:



13988
13989
13990
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13988

def message_integration_payload
  @message_integration_payload
end

#message_origin ⇒ String

Where the message was posted from Corresponds to the JSON property messageOrigin

Returns:

  • (String) 


13993
13994
13995
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13993

def message_origin
  @message_origin
end

#message_reference ⇒ Google::Apis::CloudsearchV1::MessageReference

Contains reference to another message. It is used in shortcuts which are used to collect messages from different spaces with a certain common property into another space. For example, all @mentions of a user are collected into a mention shortcut space (go/chat-shortcuts-backend-design for more details). Clients can use this reference to enable navigation to the source message when the shortcut message is clicked and also to identify a few other details about the source message. Other fields (like text) from the source message are copied on to the top-level fields in the Message proto by the server (More details in go/chat-shortcuts-client-server-design). Corresponds to the JSON property messageReference

Returns:



14006
14007
14008
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14006

def message_reference
  @message_reference
end

#message_search_info ⇒ Google::Apis::CloudsearchV1::AppsDynamiteSharedMessageSearchInfo

Metadata used to describe how to render a message in search results page, e.g., highlighting and snipetting. In future, we can use this proto to return more search specific data attached to a message. Corresponds to the JSON property messageSearchInfo

Returns:



14013
14014
14015
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14013

def message_search_info
  @message_search_info
end

#message_state ⇒ String

State of the message, indicating whether the message is visible to all members in the group or is only visible to the sender only, or the private_message_viewer if it is set. Corresponds to the JSON property messageState

Returns:

  • (String) 


14020
14021
14022
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14020

def message_state
  @message_state
end

#number_of_unicode_emojis ⇒ Fixnum

Indicates the number of unicode emojis in the message. Corresponds to the JSON property numberOfUnicodeEmojis

Returns:

  • (Fixnum) 


14025
14026
14027
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14025

def number_of_unicode_emojis
  @number_of_unicode_emojis
end

#origin_app_suggestions ⇒ Array<Google::Apis::CloudsearchV1::AppsDynamiteSharedOriginAppSuggestion>

Indicates if this message contains any suggestions that were provided by any Apps. Corresponds to the JSON property originAppSuggestions

Returns:



14031
14032
14033
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14031

def origin_app_suggestions
  @origin_app_suggestions
end

#personal_labels ⇒ Array<Google::Apis::CloudsearchV1::PersonalLabelTag>

Personal labels associated with a message for the viewing user. Order of entries is arbitrary and will not list duplicates of the same label_id. See go/ chat-labels-design for details. NOTE: This will be unpopulated in the case of SpaceChangelog events. Corresponds to the JSON property personalLabels

Returns:



14039
14040
14041
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14039

def personal_labels
  @personal_labels
end

#private_message_infos ⇒ Array<Google::Apis::CloudsearchV1::PrivateMessageInfo>

A list of per-user private information. This is deprecated, because we no longer plan to support partially private messages or private messages for multiple users. The message_state and private_message_viewer fields should be sufficient for this infrastructure. Corresponds to the JSON property privateMessageInfos

Returns:



14047
14048
14049
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14047

def private_message_infos
  @private_message_infos
end

#private_message_viewer ⇒ Google::Apis::CloudsearchV1::UserId

Primary key for User resource. Corresponds to the JSON property privateMessageViewer

Returns:



14052
14053
14054
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14052

def private_message_viewer
  @private_message_viewer
end

#props ⇒ Google::Apis::CloudsearchV1::MessageProps

Container for storing properties applicable to messages. For now (until storage consolidation is complete), it will only be used for babel props. In the future it could be used to house Dynamite properties for experimenting/ rapid prototyping. Corresponds to the JSON property props

Returns:



14060
14061
14062
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14060

def props
  @props
end

#quoted_by_state ⇒ String

Output only. Whether this message has been quoted by another message or not. Used by clients to handle message edit flows for messages that have been quoted. Corresponds to the JSON property quotedByState

Returns:

  • (String) 


14067
14068
14069
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14067

def quoted_by_state
  @quoted_by_state
end

#quoted_message_metadata ⇒ Google::Apis::CloudsearchV1::QuotedMessageMetadata

Quote metadata: go/message-quoting-be-dd-v2. This proto is only used on the read path. For the request proto, refer to QuotedMessagePayload. Fields are either derived from storage directly from the Item this metadata belongs to, or is hydrated at read time from another Item read. Note: QuotedMessageMetadata proto is similar to Message proto with less field. Reasons to differtiate QuotedMessageMetadata from Message are: 1. Not all fields for original message is applicable for quoted message. (E.g. reactions, is_inline_reply, etc.), thus separting out for confusion. 2. We don't support nested message quoting. For more detailed discussion, please see http://shortn/ _VsSXQb2C7P. For future reference: if your new feature/field will be supported in message quoting feature (go/chat-quoting-prd), you will need to add that field within QuotedMessageMetadata Corresponds to the JSON property quotedMessageMetadata

Returns:



14083
14084
14085
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14083

def quoted_message_metadata
  @quoted_message_metadata
end

#reactions ⇒ Array<Google::Apis::CloudsearchV1::AppsDynamiteSharedReaction>

A list of user reactions to this message. Ordered by the timestamp of the first reaction, ascending (oldest to newest). Corresponds to the JSON property reactions

Returns:



14089
14090
14091
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14089

def reactions
  @reactions
end

#reports ⇒ Array<Google::Apis::CloudsearchV1::ContentReport>

Output only. Details of content reports. Set only when the request asks for it. Corresponds to the JSON property reports

Returns:



14094
14095
14096
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14094

def reports
  @reports
end

#retention_settings ⇒ Google::Apis::CloudsearchV1::AppsDynamiteSharedRetentionSettings

The settings of retention period of a message or topic. Corresponds to the JSON property retentionSettings

Returns:



14099
14100
14101
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14099

def retention_settings
  @retention_settings
end

#rich_text_formatting_type ⇒ String

Used by clients to correctly log format type for message creation due to complexity with client side optimistic update (see go/content-metric-post-send- logging for details). Currently, only set by server in the message or topic creation path. Corresponds to the JSON property richTextFormattingType

Returns:

  • (String) 


14107
14108
14109
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14107

def rich_text_formatting_type
  @rich_text_formatting_type
end

#secondary_message_key ⇒ String

A client-specified string that can be used to uniquely identify a message in a space, in lieu of id.message_id. Corresponds to the JSON property secondaryMessageKey

Returns:

  • (String) 


14113
14114
14115
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14113

def secondary_message_key
  @secondary_message_key
end

#text_body ⇒ String

Plaintext body of the Message. Corresponds to the JSON property textBody

Returns:

  • (String) 


14118
14119
14120
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14118

def text_body
  @text_body
end

#tombstone_metadata ⇒ Google::Apis::CloudsearchV1::TombstoneMetadata

Tombstoning is the act of leaving a contextual trace when deleting a message. See more: go/tombstone-prd, go/hub-dynamite-tombstones-server-design-v2. Corresponds to the JSON property tombstoneMetadata

Returns:



14124
14125
14126
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14124

def tombstone_metadata
  @tombstone_metadata
end

#updater_id ⇒ Google::Apis::CloudsearchV1::UserId

Primary key for User resource. Corresponds to the JSON property updaterId

Returns:



14129
14130
14131
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14129

def updater_id
  @updater_id
end

#upload_metadata ⇒ Array<Google::Apis::CloudsearchV1::UploadMetadata>

UploadMetadata b/36864213 is an ongoing effort to move UploadMetadata out of annotations field and save it to upload_metadata field only. After the migration, UploadMetadata will only be saved in this field. Corresponds to the JSON property uploadMetadata

Returns:



14136
14137
14138
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14136

def upload_metadata
  @upload_metadata
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14143
14144
14145
14146
14147
14148
14149
14150
14151
14152
14153
14154
14155
14156
14157
14158
14159
14160
14161
14162
14163
14164
14165
14166
14167
14168
14169
14170
14171
14172
14173
14174
14175
14176
14177
14178
14179
14180
14181
14182
14183
14184
14185
14186
14187
14188
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14143

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @app_profile = args[:app_profile] if args.key?(:app_profile)
  @attachments = args[:attachments] if args.key?(:attachments)
  @attributes = args[:attributes] if args.key?(:attributes)
  @bot_responses = args[:bot_responses] if args.key?(:bot_responses)
  @communal_labels = args[:communal_labels] if args.key?(:communal_labels)
  @content_report_summary = args[:content_report_summary] if args.key?(:content_report_summary)
  @create_time = args[:create_time] if args.key?(:create_time)
  @creator_id = args[:creator_id] if args.key?(:creator_id)
  @deletable_by = args[:deletable_by] if args.key?(:deletable_by)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @delete_time_for_requester = args[:delete_time_for_requester] if args.key?(:delete_time_for_requester)
  @deleted_by_vault = args[:deleted_by_vault] if args.key?(:deleted_by_vault)
  @dlp_scan_summary = args[:dlp_scan_summary] if args.key?(:dlp_scan_summary)
  @editable_by = args[:editable_by] if args.key?(:editable_by)
  @fallback_text = args[:fallback_text] if args.key?(:fallback_text)
  @id = args[:id] if args.key?(:id)
  @is_content_purged = args[:is_content_purged] if args.key?(:is_content_purged)
  @is_inline_reply = args[:is_inline_reply] if args.key?(:is_inline_reply)
  @last_edit_time = args[:last_edit_time] if args.key?(:last_edit_time)
  @last_update_time = args[:last_update_time] if args.key?(:last_update_time)
  @local_id = args[:local_id] if args.key?(:local_id)
  @message_integration_payload = args[:message_integration_payload] if args.key?(:message_integration_payload)
  @message_origin = args[:message_origin] if args.key?(:message_origin)
  @message_reference = args[:message_reference] if args.key?(:message_reference)
  @message_search_info = args[:message_search_info] if args.key?(:message_search_info)
  @message_state = args[:message_state] if args.key?(:message_state)
  @number_of_unicode_emojis = args[:number_of_unicode_emojis] if args.key?(:number_of_unicode_emojis)
  @origin_app_suggestions = args[:origin_app_suggestions] if args.key?(:origin_app_suggestions)
  @personal_labels = args[:personal_labels] if args.key?(:personal_labels)
  @private_message_infos = args[:private_message_infos] if args.key?(:private_message_infos)
  @private_message_viewer = args[:private_message_viewer] if args.key?(:private_message_viewer)
  @props = args[:props] if args.key?(:props)
  @quoted_by_state = args[:quoted_by_state] if args.key?(:quoted_by_state)
  @quoted_message_metadata = args[:quoted_message_metadata] if args.key?(:quoted_message_metadata)
  @reactions = args[:reactions] if args.key?(:reactions)
  @reports = args[:reports] if args.key?(:reports)
  @retention_settings = args[:retention_settings] if args.key?(:retention_settings)
  @rich_text_formatting_type = args[:rich_text_formatting_type] if args.key?(:rich_text_formatting_type)
  @secondary_message_key = args[:secondary_message_key] if args.key?(:secondary_message_key)
  @text_body = args[:text_body] if args.key?(:text_body)
  @tombstone_metadata = args[:tombstone_metadata] if args.key?(:tombstone_metadata)
  @updater_id = args[:updater_id] if args.key?(:updater_id)
  @upload_metadata = args[:upload_metadata] if args.key?(:upload_metadata)
end