Class: Google::Apis::CloudsearchV1::LinkData

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

Link metadata, for LINK segments. Anchor text should be stored in the "text" field of the Segment, which can also serve as a fallback.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ LinkData

Returns a new instance of LinkData.



13127
13128
13129
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13127

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

Instance Attribute Details

#attachment ⇒ Google::Apis::CloudsearchV1::SocialCommonAttachmentAttachment

An Attachment represents a linked entity associated with a piece of social content. This may be a 1st-party or 3rd-party entity. In the Papyrus context, an Attachment is part of a Cent, and sits alongside the main content of the cent, which is represented as a sequence of Segments. Right now an Attachment is just a wrapper around an Embed, but we provide the extra layer of abstraction since, as Embeds move to separate storage in Briefcase, we may want to add additional fields that are not part of the Embed proper, but that ( for example) relate to the usage of the linked content within the particular post/cent. Corresponds to the JSON property attachment

Returns:



13091
13092
13093
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13091

def attachment
  @attachment
end

#attachment_render_hint ⇒ String

The hint to use when rendering the associated attachment. Ignored if there is no associated attachment. Corresponds to the JSON property attachmentRenderHint

Returns:

  • (String) 


13097
13098
13099
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13097

def attachment_render_hint
  @attachment_render_hint
end

#display_url ⇒ String

If we wish to show the user a different (e.g. shortened) version of the URL for display purposes, then that version should be set here. If this field isn' t set, link_target will be used for both purposes. Corresponds to the JSON property displayUrl

Returns:

  • (String) 


13104
13105
13106
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13104

def display_url
  @display_url
end

#link_target ⇒ String

link_target is the URL to navigate to when clicked. This could be the original URL, or a URL signed by the GWS URL signing service. Corresponds to the JSON property linkTarget

Returns:

  • (String) 


13110
13111
13112
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13110

def link_target
  @link_target
end

#link_type ⇒ String

LinkType is an optional field that provides additional information regarding link target. For example, link type can be identified as the SELF_LINK when the request was executed from the same link as the link target. Corresponds to the JSON property linkType

Returns:

  • (String) 


13117
13118
13119
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13117

def link_type
  @link_type
end

#title ⇒ String

Title is an optional field that provides a short string that describes the link or its destination. User interfaces often use title as a tooltip or for accessibility purposes. However, they are of course free to present this data in any form. This field is plain text. Corresponds to the JSON property title

Returns:

  • (String) 


13125
13126
13127
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13125

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13132
13133
13134
13135
13136
13137
13138
13139
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13132

def update!(**args)
  @attachment = args[:attachment] if args.key?(:attachment)
  @attachment_render_hint = args[:attachment_render_hint] if args.key?(:attachment_render_hint)
  @display_url = args[:display_url] if args.key?(:display_url)
  @link_target = args[:link_target] if args.key?(:link_target)
  @link_type = args[:link_type] if args.key?(:link_type)
  @title = args[:title] if args.key?(:title)
end