Class: Google::Apis::CloudsearchV1::Annotation

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

NOTE WHEN ADDING NEW PROTO FIELDS: Be sure to add datapol annotations to new fields with potential PII, so they get scrubbed when logging protos for errors. NEXT TAG: 32

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Annotation

Returns a new instance of Annotation.



542
543
544
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 542

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

Instance Attribute Details

#babel_placeholder_metadata ⇒ Google::Apis::CloudsearchV1::BabelPlaceholderMetadata

Annotation metadata for Babel-only items that signals which type of placeholder message should be displayed in Babel clients. Corresponds to the JSON property babelPlaceholderMetadata

Returns:



359
360
361
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 359

def babel_placeholder_metadata
  @babel_placeholder_metadata
end

#card_capability_metadata ⇒ Google::Apis::CloudsearchV1::CardCapabilityMetadata

LINT.ThenChange(//depot/google3/java/com/google/apps/dynamite/v1/backend/ action/common/SystemMessageHelper.java) Corresponds to the JSON property cardCapabilityMetadata

Returns:



365
366
367
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 365

def card_capability_metadata
  @card_capability_metadata
end

#chip_render_type ⇒ String

Whether the annotation should be rendered as a preview chip. If this is missing or unspecified, fallback to should_not_render on the metadata. Corresponds to the JSON property chipRenderType

Returns:

  • (String) 


371
372
373
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 371

def chip_render_type
  @chip_render_type
end

#component_search_info ⇒ Google::Apis::CloudsearchV1::AppsDynamiteSharedMessageComponentSearchInfo

Metadata used to describe search information in a specific component of a chat message, for example an annotation or an attachment. Corresponds to the JSON property componentSearchInfo

Returns:



377
378
379
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 377

def component_search_info
  @component_search_info
end

#consented_app_unfurl_metadata ⇒ Google::Apis::CloudsearchV1::ConsentedAppUnfurlMetadata

Annotation metadata app unfurl consent. Corresponds to the JSON property consentedAppUnfurlMetadata

Returns:



382
383
384
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 382

def consented_app_unfurl_metadata
  @consented_app_unfurl_metadata
end

#custom_emoji_metadata ⇒ Google::Apis::CloudsearchV1::CustomEmojiMetadata

Corresponds to the JSON property customEmojiMetadata

Returns:



387
388
389
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 387

def custom_emoji_metadata
  @custom_emoji_metadata
end

#data_loss_prevention_metadata ⇒ Google::Apis::CloudsearchV1::DataLossPreventionMetadata

Annotation metadata for Data Loss Prevention that pertains to DLP violation on message send or edit events. It is used for client -> BE communication and other downstream process in BE (e.g. storage and audit logging), and it should never be returned to the client. Corresponds to the JSON property dataLossPreventionMetadata

Returns:



395
396
397
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 395

def data_loss_prevention_metadata
  @data_loss_prevention_metadata
end

#drive_metadata ⇒ Google::Apis::CloudsearchV1::DriveMetadata

Annotation metadata for Drive artifacts. Corresponds to the JSON property driveMetadata

Returns:



400
401
402
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 400

def drive_metadata
  @drive_metadata
end

#format_metadata ⇒ Google::Apis::CloudsearchV1::FormatMetadata

Annotation metadata for markup formatting Corresponds to the JSON property formatMetadata

Returns:



405
406
407
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 405

def format_metadata
  @format_metadata
end

#group_retention_settings_updated ⇒ Google::Apis::CloudsearchV1::GroupRetentionSettingsUpdatedMetaData

Corresponds to the JSON property groupRetentionSettingsUpdated

Returns:



410
411
412
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 410

def group_retention_settings_updated
  @group_retention_settings_updated
end

#gsuite_integration_metadata ⇒ Google::Apis::CloudsearchV1::GsuiteIntegrationMetadata

Annotation metadata for a GsuiteIntegration artifact. Corresponds to the JSON property gsuiteIntegrationMetadata

Returns:



415
416
417
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 415

def gsuite_integration_metadata
  @gsuite_integration_metadata
end

#incoming_webhook_changed_metadata ⇒ Google::Apis::CloudsearchV1::IncomingWebhookChangedMetadata

Annotation metadata to display system messages for incoming webhook events. Next Tag: 7 Corresponds to the JSON property incomingWebhookChangedMetadata

Returns:



421
422
423
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 421

def incoming_webhook_changed_metadata
  @incoming_webhook_changed_metadata
end

#inline_render_format ⇒ String

The inline render format of this annotation. go/drive-smart-chips-chat-v2. Corresponds to the JSON property inlineRenderFormat

Returns:

  • (String) 


426
427
428
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 426

def inline_render_format
  @inline_render_format
end

#integration_config_updated ⇒ Google::Apis::CloudsearchV1::IntegrationConfigUpdatedMetadata

Annotation metadata to display system message for integration config updated event. This metadata is stored in spanner, and can be dispatched to clients without any field modification or transformation. Corresponds to the JSON property integrationConfigUpdated

Returns:



433
434
435
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 433

def integration_config_updated
  @integration_config_updated
end

#interaction_data ⇒ Google::Apis::CloudsearchV1::InteractionData

Interaction data for an annotation, which may be supplemental to the metadata oneof. For example, this will contain the fully built navigation target for smart chips. NEXT TAG: 2 Corresponds to the JSON property interactionData

Returns:



440
441
442
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 440

def interaction_data
  @interaction_data
end

#length ⇒ Fixnum

Length of the text_body substring beginning from start_index the Annotation corresponds to. Corresponds to the JSON property length

Returns:

  • (Fixnum) 


446
447
448
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 446

def length
  @length
end

#local_id ⇒ String

  • A client-assigned ID for this annotation. This is helpful in matching the back-filled annotations to the original annotations on client side, without having to re-parse the message. There is no guarantee an annotation has a local_id, it's a purely client used and controlled field with no guarantee of uniqueness. Corresponds to the JSON property localId

Returns:

  • (String) 


455
456
457
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 455

def local_id
  @local_id
end

#membership_changed ⇒ Google::Apis::CloudsearchV1::MembershipChangedMetadata

Annotation metadata to display system messages for membership changes. Next Tag: 13 Corresponds to the JSON property membershipChanged

Returns:



461
462
463
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 461

def membership_changed
  @membership_changed
end

#read_receipts_settings_metadata ⇒ Google::Apis::CloudsearchV1::ReadReceiptsSettingsUpdatedMetadata

Corresponds to the JSON property readReceiptsSettingsMetadata

Returns:



466
467
468
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 466

def read_receipts_settings_metadata
  @read_receipts_settings_metadata
end

#required_message_features_metadata ⇒ Google::Apis::CloudsearchV1::RequiredMessageFeaturesMetadata

A list of capabilities that are used in this message. Corresponds to the JSON property requiredMessageFeaturesMetadata

Returns:



471
472
473
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 471

def required_message_features_metadata
  @required_message_features_metadata
end

#room_updated ⇒ Google::Apis::CloudsearchV1::RoomUpdatedMetadata

Corresponds to the JSON property roomUpdated

Returns:



476
477
478
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 476

def room_updated
  @room_updated
end

#server_invalidated ⇒ Boolean Also known as: server_invalidated?

Whether or not the annotation is invalidated by the server. Example of situations for invalidation include: when the URL is malformed, or when Drive item ID is rejected by Drive Service. Corresponds to the JSON property serverInvalidated

Returns:

  • (Boolean) 


483
484
485
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 483

def server_invalidated
  @server_invalidated
end

#slash_command_metadata ⇒ Google::Apis::CloudsearchV1::SlashCommandMetadata

Annotation metadata for slash commands (/). Corresponds to the JSON property slashCommandMetadata

Returns:



489
490
491
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 489

def slash_command_metadata
  @slash_command_metadata
end

#start_index ⇒ Fixnum

Start index (0-indexed) of the Message text the Annotation corresponds to, inclusive. Corresponds to the JSON property startIndex

Returns:

  • (Fixnum) 


495
496
497
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 495

def start_index
  @start_index
end

#type ⇒ String

Type of the Annotation. Corresponds to the JSON property type

Returns:

  • (String) 


500
501
502
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 500

def type
  @type
end

#unique_id ⇒ String

  • A unique server-assigned ID for this annotation. This is helpful in matching annotation objects when fetched from service. All uploads should have a unique_id after the message they are attached to is successfully sent. Url annotations that originally were uploads (i.e. policy violations) will have a unique_id after the message they are attached to is successfully sent. No other url annotations should have a unique_id. All drive annotations should have a unique_id after the message they are attached to is successfully sent. Corresponds to the JSON property uniqueId

Returns:

  • (String) 


511
512
513
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 511

def unique_id
  @unique_id
end

#upload_metadata ⇒ Google::Apis::CloudsearchV1::UploadMetadata

Annotation metadata for user Upload artifacts. Corresponds to the JSON property uploadMetadata

Returns:



516
517
518
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 516

def upload_metadata
  @upload_metadata
end

#url_metadata ⇒ Google::Apis::CloudsearchV1::UrlMetadata

Annotation metadata for a Weblink. In case of pasted link it can qualify to be other types in addition to being a URL - like DRIVE_DOC/DRIVE_SHEET and so on. The URL metadata will also be present and it's up to the client to decide which metadata to render it with. These fields are filled in using page render service. Corresponds to the JSON property urlMetadata

Returns:



525
526
527
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 525

def url_metadata
  @url_metadata
end

#user_mention_metadata ⇒ Google::Apis::CloudsearchV1::UserMentionMetadata

Annotation metadata for user mentions (+/@/-). Corresponds to the JSON property userMentionMetadata

Returns:



530
531
532
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 530

def user_mention_metadata
  @user_mention_metadata
end

#video_call_metadata ⇒ Google::Apis::CloudsearchV1::VideoCallMetadata

Corresponds to the JSON property videoCallMetadata

Returns:



535
536
537
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 535

def video_call_metadata
  @video_call_metadata
end

#youtube_metadata ⇒ Google::Apis::CloudsearchV1::YoutubeMetadata

Annotation metadata for YouTube artifact. Corresponds to the JSON property youtubeMetadata

Returns:



540
541
542
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 540

def youtube_metadata
  @youtube_metadata
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 547

def update!(**args)
  @babel_placeholder_metadata = args[:babel_placeholder_metadata] if args.key?(:babel_placeholder_metadata)
  @card_capability_metadata = args[:card_capability_metadata] if args.key?(:card_capability_metadata)
  @chip_render_type = args[:chip_render_type] if args.key?(:chip_render_type)
  @component_search_info = args[:component_search_info] if args.key?(:component_search_info)
  @consented_app_unfurl_metadata = args[:consented_app_unfurl_metadata] if args.key?(:consented_app_unfurl_metadata)
  @custom_emoji_metadata = args[:custom_emoji_metadata] if args.key?(:custom_emoji_metadata)
  @data_loss_prevention_metadata = args[:data_loss_prevention_metadata] if args.key?(:data_loss_prevention_metadata)
  @drive_metadata = args[:drive_metadata] if args.key?(:drive_metadata)
  @format_metadata = args[:format_metadata] if args.key?(:format_metadata)
  @group_retention_settings_updated = args[:group_retention_settings_updated] if args.key?(:group_retention_settings_updated)
  @gsuite_integration_metadata = args[:gsuite_integration_metadata] if args.key?(:gsuite_integration_metadata)
  @incoming_webhook_changed_metadata = args[:incoming_webhook_changed_metadata] if args.key?(:incoming_webhook_changed_metadata)
  @inline_render_format = args[:inline_render_format] if args.key?(:inline_render_format)
  @integration_config_updated = args[:integration_config_updated] if args.key?(:integration_config_updated)
  @interaction_data = args[:interaction_data] if args.key?(:interaction_data)
  @length = args[:length] if args.key?(:length)
  @local_id = args[:local_id] if args.key?(:local_id)
  @membership_changed = args[:membership_changed] if args.key?(:membership_changed)
  @read_receipts_settings_metadata = args[:read_receipts_settings_metadata] if args.key?(:read_receipts_settings_metadata)
  @required_message_features_metadata = args[:required_message_features_metadata] if args.key?(:required_message_features_metadata)
  @room_updated = args[:room_updated] if args.key?(:room_updated)
  @server_invalidated = args[:server_invalidated] if args.key?(:server_invalidated)
  @slash_command_metadata = args[:slash_command_metadata] if args.key?(:slash_command_metadata)
  @start_index = args[:start_index] if args.key?(:start_index)
  @type = args[:type] if args.key?(:type)
  @unique_id = args[:unique_id] if args.key?(:unique_id)
  @upload_metadata = args[:upload_metadata] if args.key?(:upload_metadata)
  @url_metadata = args[:url_metadata] if args.key?(:url_metadata)
  @user_mention_metadata = args[:user_mention_metadata] if args.key?(:user_mention_metadata)
  @video_call_metadata = args[:video_call_metadata] if args.key?(:video_call_metadata)
  @youtube_metadata = args[:youtube_metadata] if args.key?(:youtube_metadata)
end