Class: Google::Apis::CloudsearchV1::UrlMetadata

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

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ UrlMetadata

Returns a new instance of UrlMetadata.



20647
20648
20649
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20647

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

Instance Attribute Details

#domain ⇒ String

Domain for this url. If it's an IP address the address is returned. Corresponds to the JSON property domain

Returns:

  • (String) 


20561
20562
20563
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20561

def domain
  @domain
end

#gws_url ⇒ Google::Apis::CloudsearchV1::SafeUrlProto

Message containing a string that is safe to use in URL contexts in DOM APIs and HTML documents, where the URL context does not refer to a resource that loads code. Corresponds to the JSON property gwsUrl

Returns:



20568
20569
20570
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20568

def gws_url
  @gws_url
end

#gws_url_expiration_timestamp ⇒ Fixnum

The expiration timestamp for GWS URL, only set when gws_url is set. Corresponds to the JSON property gwsUrlExpirationTimestamp

Returns:

  • (Fixnum) 


20573
20574
20575
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20573

def gws_url_expiration_timestamp
  @gws_url_expiration_timestamp
end

#image_height ⇒ String

Dimensions of the image: height. This field is string to match with page render service response. Deprecated. Use int_image_height instead. Corresponds to the JSON property imageHeight

Returns:

  • (String) 


20579
20580
20581
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20579

def image_height
  @image_height
end

#image_url ⇒ String

Representative image of the website. Corresponds to the JSON property imageUrl

Returns:

  • (String) 


20584
20585
20586
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20584

def image_url
  @image_url
end

#image_width ⇒ String

Dimensions of the image: width. This field is string to match with page render service response. Deprecated. Use int_image_height instead. Corresponds to the JSON property imageWidth

Returns:

  • (String) 


20590
20591
20592
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20590

def image_width
  @image_width
end

#int_image_height ⇒ Fixnum

Dimensions of the image: height. Corresponds to the JSON property intImageHeight

Returns:

  • (Fixnum) 


20595
20596
20597
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20595

def int_image_height
  @int_image_height
end

#int_image_width ⇒ Fixnum

Dimensions of the image: width. Corresponds to the JSON property intImageWidth

Returns:

  • (Fixnum) 


20600
20601
20602
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20600

def int_image_width
  @int_image_width
end

#mime_type ⇒ String

Mime type of the content (Currently mapped from Page Render Service ItemType) Note that this is not necessarily the mime type of the http resource. For example a text/html from youtube or vimeo may actually be classified as a video type. Then we shall mark it as video/* since we don't know exactly what type of video it is. Corresponds to the JSON property mimeType

Returns:

  • (String) 


20609
20610
20611
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20609

def mime_type
  @mime_type
end

#redirect_url ⇒ Google::Apis::CloudsearchV1::SafeUrlProto

Message containing a string that is safe to use in URL contexts in DOM APIs and HTML documents, where the URL context does not refer to a resource that loads code. Corresponds to the JSON property redirectUrl

Returns:



20616
20617
20618
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20616

def redirect_url
  @redirect_url
end

#should_not_render ⇒ Boolean Also known as: should_not_render?

If the UrlMetadata is missing data for rendering a chip. Deprecated. Use Annotation.ChipRenderType instead. Corresponds to the JSON property shouldNotRender

Returns:

  • (Boolean) 


20622
20623
20624
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20622

def should_not_render
  @should_not_render
end

#snippet ⇒ String

Snippet/small description of the weblink. Corresponds to the JSON property snippet

Returns:

  • (String) 


20628
20629
20630
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20628

def snippet
  @snippet
end

#title ⇒ String

Title of the Weblink. Corresponds to the JSON property title

Returns:

  • (String) 


20633
20634
20635
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20633

def title
  @title
end

#url ⇒ Google::Apis::CloudsearchV1::SafeUrlProto

Message containing a string that is safe to use in URL contexts in DOM APIs and HTML documents, where the URL context does not refer to a resource that loads code. Corresponds to the JSON property url

Returns:



20640
20641
20642
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20640

def url
  @url
end

#url_source ⇒ String

Corresponds to the JSON property urlSource

Returns:

  • (String) 


20645
20646
20647
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20645

def url_source
  @url_source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



20652
20653
20654
20655
20656
20657
20658
20659
20660
20661
20662
20663
20664
20665
20666
20667
20668
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20652

def update!(**args)
  @domain = args[:domain] if args.key?(:domain)
  @gws_url = args[:gws_url] if args.key?(:gws_url)
  @gws_url_expiration_timestamp = args[:gws_url_expiration_timestamp] if args.key?(:gws_url_expiration_timestamp)
  @image_height = args[:image_height] if args.key?(:image_height)
  @image_url = args[:image_url] if args.key?(:image_url)
  @image_width = args[:image_width] if args.key?(:image_width)
  @int_image_height = args[:int_image_height] if args.key?(:int_image_height)
  @int_image_width = args[:int_image_width] if args.key?(:int_image_width)
  @mime_type = args[:mime_type] if args.key?(:mime_type)
  @redirect_url = args[:redirect_url] if args.key?(:redirect_url)
  @should_not_render = args[:should_not_render] if args.key?(:should_not_render)
  @snippet = args[:snippet] if args.key?(:snippet)
  @title = args[:title] if args.key?(:title)
  @url = args[:url] if args.key?(:url)
  @url_source = args[:url_source] if args.key?(:url_source)
end