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.



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

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) 


20474
20475
20476
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20474

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:



20481
20482
20483
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20481

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) 


20486
20487
20488
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20486

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) 


20492
20493
20494
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20492

def image_height
  @image_height
end

#image_url ⇒ String

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

Returns:

  • (String) 


20497
20498
20499
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20497

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) 


20503
20504
20505
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20503

def image_width
  @image_width
end

#int_image_height ⇒ Fixnum

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

Returns:

  • (Fixnum) 


20508
20509
20510
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20508

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) 


20513
20514
20515
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20513

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) 


20522
20523
20524
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20522

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:



20529
20530
20531
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20529

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) 


20535
20536
20537
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20535

def should_not_render
  @should_not_render
end

#snippet ⇒ String

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

Returns:

  • (String) 


20541
20542
20543
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20541

def snippet
  @snippet
end

#title ⇒ String

Title of the Weblink. Corresponds to the JSON property title

Returns:

  • (String) 


20546
20547
20548
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20546

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:



20553
20554
20555
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20553

def url
  @url
end

#url_source ⇒ String

Corresponds to the JSON property urlSource

Returns:

  • (String) 


20558
20559
20560
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20558

def url_source
  @url_source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



20565
20566
20567
20568
20569
20570
20571
20572
20573
20574
20575
20576
20577
20578
20579
20580
20581
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20565

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