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.



11602
11603
11604
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11602

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:



11343
11344
11345
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11343

def annotations
  @annotations
end

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

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

Returns:



11348
11349
11350
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11348

def app_profile
  @app_profile
end

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

Attachments parsed from incoming webhooks Corresponds to the JSON property attachments

Returns:



11353
11354
11355
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11353

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:



11358
11359
11360
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11358

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:



11363
11364
11365
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11363

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:



11371
11372
11373
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11371

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:



11377
11378
11379
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11377

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) 


11382
11383
11384
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11382

def create_time
  @create_time
end

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

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

Returns:



11387
11388
11389
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11387

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) 


11394
11395
11396
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11394

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) 


11400
11401
11402
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11400

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) 


11407
11408
11409
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11407

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) 


11413
11414
11415
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11413

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) 


11421
11422
11423
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11421

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:



11428
11429
11430
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11428

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) 


11435
11436
11437
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11435

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) 


11441
11442
11443
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11441

def fallback_text
  @fallback_text
end

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

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

Returns:



11446
11447
11448
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11446

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) 


11454
11455
11456
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11454

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) 


11462
11463
11464
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11462

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) 


11469
11470
11471
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11469

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) 


11474
11475
11476
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11474

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) 


11479
11480
11481
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11479

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:



11485
11486
11487
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11485

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) 


11490
11491
11492
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11490

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) 


11497
11498
11499
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11497

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:



11503
11504
11505
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11503

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:



11511
11512
11513
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11511

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:



11519
11520
11521
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11519

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:



11524
11525
11526
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11524

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:



11532
11533
11534
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11532

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) 


11539
11540
11541
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11539

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:



11555
11556
11557
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11555

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:



11561
11562
11563
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11561

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:



11566
11567
11568
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11566

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:



11571
11572
11573
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11571

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) 


11577
11578
11579
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11577

def secondary_message_key
  @secondary_message_key
end

#text_body ⇒ String

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

Returns:

  • (String) 


11582
11583
11584
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11582

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:



11588
11589
11590
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11588

def tombstone_metadata
  @tombstone_metadata
end

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

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

Returns:



11593
11594
11595
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11593

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:



11600
11601
11602
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11600

def upload_metadata
  @upload_metadata
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11607

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