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.



17329
17330
17331
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17329

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) 


17248
17249
17250
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17248

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:



17255
17256
17257
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17255

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) 


17260
17261
17262
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17260

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) 


17266
17267
17268
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17266

def image_height
  @image_height
end

#image_url ⇒ String

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

Returns:

  • (String) 


17271
17272
17273
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17271

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) 


17277
17278
17279
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17277

def image_width
  @image_width
end

#int_image_height ⇒ Fixnum

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

Returns:

  • (Fixnum) 


17282
17283
17284
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17282

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) 


17287
17288
17289
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17287

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. NEXT TAG : 16 Corresponds to the JSON property mimeType

Returns:

  • (String) 


17296
17297
17298
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17296

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:



17303
17304
17305
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17303

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) 


17309
17310
17311
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17309

def should_not_render
  @should_not_render
end

#snippet ⇒ String

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

Returns:

  • (String) 


17315
17316
17317
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17315

def snippet
  @snippet
end

#title ⇒ String

Title of the Weblink. Corresponds to the JSON property title

Returns:

  • (String) 


17320
17321
17322
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17320

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:



17327
17328
17329
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17327

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



17334
17335
17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
17349
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17334

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)
end