Class: Google::Apis::CloudsearchV1::Provenance

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

This field records where the ItemScope was retrieved, if it was created via a web fetch.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Provenance

Returns a new instance of Provenance.



16256
16257
16258
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16256

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

Instance Attribute Details

#annotation_blobString

Annotation blob from Annotation Service. Corresponds to the JSON property annotationBlob NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String)


16221
16222
16223
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16221

def annotation_blob
  @annotation_blob
end

#canonical_urlString

Canonical url of the retrieved_url, if one was resolved during retrieval, for example, if a rel="canonical" link tag was provided in the retrieved web page. Corresponds to the JSON property canonicalUrl

Returns:

  • (String)


16227
16228
16229
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16227

def canonical_url
  @canonical_url
end

#input_urlString

The url originally passed in the PRS request, which should be used to re- discover the content. Note that this URL may be a forwarding service or link shortener (bit.ly), so it should not be assumed to be canonical, but should be used for navigation back to the original source of the itemscope. Corresponds to the JSON property inputUrl

Returns:

  • (String)


16235
16236
16237
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16235

def input_url
  @input_url
end

#itemtypeArray<String>

Contains exact types as parsed, whether or not we recognized that type at parse time. If an itemscope is created by merging SchemaOrg markup and open graph markup then the first itemtype would be schemaorg type, the second would be open graph and so on. example: http://schema.org/VideoObject, og:video. movie Plain text; usually a URL Corresponds to the JSON property itemtype

Returns:

  • (Array<String>)


16244
16245
16246
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16244

def itemtype
  @itemtype
end

#retrieved_timestamp_msecFixnum

The server retrieved timestamp (in msec). Corresponds to the JSON property retrievedTimestampMsec

Returns:

  • (Fixnum)


16249
16250
16251
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16249

def retrieved_timestamp_msec
  @retrieved_timestamp_msec
end

#retrieved_urlString

The final URL that was the actual source of the itemscope, after any redirects. Corresponds to the JSON property retrievedUrl

Returns:

  • (String)


16254
16255
16256
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16254

def retrieved_url
  @retrieved_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16261
16262
16263
16264
16265
16266
16267
16268
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16261

def update!(**args)
  @annotation_blob = args[:annotation_blob] if args.key?(:annotation_blob)
  @canonical_url = args[:canonical_url] if args.key?(:canonical_url)
  @input_url = args[:input_url] if args.key?(:input_url)
  @itemtype = args[:itemtype] if args.key?(:itemtype)
  @retrieved_timestamp_msec = args[:retrieved_timestamp_msec] if args.key?(:retrieved_timestamp_msec)
  @retrieved_url = args[:retrieved_url] if args.key?(:retrieved_url)
end