Class: Google::Apis::CloudsearchV1::EmbedClientItem

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

Represents an embedded object in an update. This is a wrapper class that can contain a single specific item proto in an extension field. Think of it as a base class like Message in Java. Each item proto must declare that it extends this proto: message ExampleObject option (item_type) = EXAMPLE_OBJECT; extend EmbedClientItem optional ExampleObject example_object = ; See go/es-embeds for details.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EmbedClientItem

Returns a new instance of EmbedClientItem.



8009
8010
8011
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8009

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

Instance Attribute Details

#canonical_id ⇒ String

The canonical ID of the embed. If absent, the canonical ID is equal to the ID; if present, then the canonical ID represents an "equivalence class" of embeds which really refer to the same object. (For example, the URLs http://www.foo. com/ and http://foo.com/ refer to the same object) This field may be updated periodically by background processes. Corresponds to the JSON property canonicalId

Returns:

  • (String) 


7962
7963
7964
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7962

def canonical_id
  @canonical_id
end

#deep_link_data ⇒ Google::Apis::CloudsearchV1::DeepLinkData

Deep-linking data is used to construct a deep-link URI for an activity or frame's embed, such that on click, the user is taken to the right place in a mobile app. If the app is not installed, the user is taken to the app store. If not on mobile, an analogous web uri is used. Corresponds to the JSON property deepLinkData

Returns:



7970
7971
7972
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7970

def deep_link_data
  @deep_link_data
end

#id ⇒ String

The ID of the embed. This corresponds to the schema.org ID, as represented in the ItemScope.id field. Corresponds to the JSON property id

Returns:

  • (String) 


7976
7977
7978
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7976

def id
  @id
end

#provenance ⇒ Google::Apis::CloudsearchV1::Provenance

This field records where the ItemScope was retrieved, if it was created via a web fetch. Corresponds to the JSON property provenance

Returns:



7982
7983
7984
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7982

def provenance
  @provenance
end

#render_id ⇒ String

The ID used to identify the embed during rendering. This field will match ID, if set, otherwise it will be the ID of the parent activity. This field is only populated on the server for client use and is not persisted to storage. Corresponds to the JSON property renderId

Returns:

  • (String) 


7989
7990
7991
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7989

def render_id
  @render_id
end

#signature ⇒ String

Signature of the embed, used for verification. Corresponds to the JSON property signature

Returns:

  • (String) 


7994
7995
7996
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7994

def signature
  @signature
end

#transient_data ⇒ Google::Apis::CloudsearchV1::TransientData

Transient generic data that will not be saved on the server. Corresponds to the JSON property transientData

Returns:



7999
8000
8001
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7999

def transient_data
  @transient_data
end

#type ⇒ Array<String>

The first value in type determines which extension field will be set. When creating an EmbedClientItem, you only need to set the first (primary) type in this field. When the server receives the item, it will populate the full type list using the parent annotations in the ItemType enum. Corresponds to the JSON property type

Returns:

  • (Array<String>) 


8007
8008
8009
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8007

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8014

def update!(**args)
  @canonical_id = args[:canonical_id] if args.key?(:canonical_id)
  @deep_link_data = args[:deep_link_data] if args.key?(:deep_link_data)
  @id = args[:id] if args.key?(:id)
  @provenance = args[:provenance] if args.key?(:provenance)
  @render_id = args[:render_id] if args.key?(:render_id)
  @signature = args[:signature] if args.key?(:signature)
  @transient_data = args[:transient_data] if args.key?(:transient_data)
  @type = args[:type] if args.key?(:type)
end