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.



12138
12139
12140
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12138

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:



11879
11880
11881
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11879

def annotations
  @annotations
end

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

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

Returns:



11884
11885
11886
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11884

def app_profile
  @app_profile
end

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

Attachments parsed from incoming webhooks Corresponds to the JSON property attachments

Returns:



11889
11890
11891
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11889

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:



11894
11895
11896
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11894

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:



11899
11900
11901
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11899

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:



11907
11908
11909
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11907

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:



11913
11914
11915
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11913

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) 


11918
11919
11920
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11918

def create_time
  @create_time
end

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

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

Returns:



11923
11924
11925
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11923

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) 


11930
11931
11932
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11930

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) 


11936
11937
11938
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11936

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) 


11943
11944
11945
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11943

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) 


11949
11950
11951
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11949

def deleted_by_vault
  @deleted_by_vault
end

#dlp_scan_outcome ⇒ String

Data Loss Prevention scan information for this message. Messages are evaluated in the backend on create message/topic and edit message actions. DEPRECATED: use dlp_scan_summary instead. Corresponds to the JSON property dlpScanOutcome

Returns:

  • (String) 


11957
11958
11959
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11957

def dlp_scan_outcome
  @dlp_scan_outcome
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:



11964
11965
11966
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11964

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) 


11971
11972
11973
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11971

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) 


11977
11978
11979
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11977

def fallback_text
  @fallback_text
end

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

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

Returns:



11982
11983
11984
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11982

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) 


11990
11991
11992
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11990

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) 


11998
11999
12000
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11998

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) 


12005
12006
12007
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12005

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) 


12010
12011
12012
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12010

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) 


12015
12016
12017
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12015

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:



12021
12022
12023
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12021

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) 


12026
12027
12028
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12026

def message_origin
  @message_origin
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) 


12033
12034
12035
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12033

def message_state
  @message_state
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:



12039
12040
12041
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12039

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:



12047
12048
12049
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12047

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:



12055
12056
12057
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12055

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:



12060
12061
12062
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12060

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:



12068
12069
12070
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12068

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) 


12075
12076
12077
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12075

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:



12091
12092
12093
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12091

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:



12097
12098
12099
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12097

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:



12102
12103
12104
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12102

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:



12107
12108
12109
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12107

def retention_settings
  @retention_settings
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) 


12113
12114
12115
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12113

def secondary_message_key
  @secondary_message_key
end

#text_body ⇒ String

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

Returns:

  • (String) 


12118
12119
12120
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12118

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:



12124
12125
12126
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12124

def tombstone_metadata
  @tombstone_metadata
end

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

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

Returns:



12129
12130
12131
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12129

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:



12136
12137
12138
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12136

def upload_metadata
  @upload_metadata
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12143

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_outcome = args[:dlp_scan_outcome] if args.key?(:dlp_scan_outcome)
  @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_state = args[:message_state] if args.key?(:message_state)
  @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)
  @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