Class: Google::Apis::CloudsearchV1::ItemMetadata

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

Available metadata fields for the item.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ItemMetadata

Returns a new instance of ItemMetadata.



2723
2724
2725
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2723

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

Instance Attribute Details

#container_name ⇒ String

The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters. Corresponds to the JSON property containerName

Returns:

  • (String) 


2643
2644
2645
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2643

def container_name
  @container_name
end

#content_language ⇒ String

The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/# Unicode_locale_identifier. The maximum length is 32 characters. Corresponds to the JSON property contentLanguage

Returns:

  • (String) 


2650
2651
2652
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2650

def content_language
  @content_language
end

#context_attributes ⇒ Array<Google::Apis::CloudsearchV1::ContextAttribute>

A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10. Corresponds to the JSON property contextAttributes

Returns:



2657
2658
2659
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2657

def context_attributes
  @context_attributes
end

#create_time ⇒ String

The time when the item was created in the source repository. Corresponds to the JSON property createTime

Returns:

  • (String) 


2662
2663
2664
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2662

def create_time
  @create_time
end

#hash_prop ⇒ String

Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters. Corresponds to the JSON property hash

Returns:

  • (String) 


2668
2669
2670
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2668

def hash_prop
  @hash_prop
end

#interactions ⇒ Array<Google::Apis::CloudsearchV1::Interaction>

A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000. Corresponds to the JSON property interactions

Returns:



2675
2676
2677
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2675

def interactions
  @interactions
end

#keywords ⇒ Array<String>

Additional keywords or phrases that should match the item. Used internally for user generated content. The maximum number of elements is 100. The maximum length is 8192 characters. Corresponds to the JSON property keywords

Returns:

  • (Array<String>) 


2682
2683
2684
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2682

def keywords
  @keywords
end

#mime_type ⇒ String

The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters. Corresponds to the JSON property mimeType

Returns:

  • (String) 


2688
2689
2690
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2688

def mime_type
  @mime_type
end

#object_type ⇒ String

The type of the item. This should correspond to the name of an object definition in the schema registered for the data source. For example, if the schema for the data source contains an object definition with name 'document', then item indexing requests for objects of that type should set objectType to ' document'. The maximum length is 256 characters. Corresponds to the JSON property objectType

Returns:

  • (String) 


2697
2698
2699
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2697

def object_type
  @object_type
end

#search_quality_metadata ⇒ Google::Apis::CloudsearchV1::SearchQualityMetadata

Additional search quality metadata of the item. Corresponds to the JSON property searchQualityMetadata

Returns:



2702
2703
2704
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2702

def search_quality_metadata
  @search_quality_metadata
end

#source_repository_url ⇒ String

Link to the source repository serving the data. Seach results apply this link to the title. Whitespace or special characters may cause Cloud Seach result links to trigger a redirect notice; to avoid this, encode the URL. The maximum length is 2048 characters. Corresponds to the JSON property sourceRepositoryUrl

Returns:

  • (String) 


2710
2711
2712
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2710

def source_repository_url
  @source_repository_url
end

#title ⇒ String

The title of the item. If given, this will be the displayed title of the Search result. The maximum length is 2048 characters. Corresponds to the JSON property title

Returns:

  • (String) 


2716
2717
2718
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2716

def title
  @title
end

#update_time ⇒ String

The time when the item was last modified in the source repository. Corresponds to the JSON property updateTime

Returns:

  • (String) 


2721
2722
2723
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2721

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2728

def update!(**args)
  @container_name = args[:container_name] if args.key?(:container_name)
  @content_language = args[:content_language] if args.key?(:content_language)
  @context_attributes = args[:context_attributes] if args.key?(:context_attributes)
  @create_time = args[:create_time] if args.key?(:create_time)
  @hash_prop = args[:hash_prop] if args.key?(:hash_prop)
  @interactions = args[:interactions] if args.key?(:interactions)
  @keywords = args[:keywords] if args.key?(:keywords)
  @mime_type = args[:mime_type] if args.key?(:mime_type)
  @object_type = args[:object_type] if args.key?(:object_type)
  @search_quality_metadata = args[:search_quality_metadata] if args.key?(:search_quality_metadata)
  @source_repository_url = args[:source_repository_url] if args.key?(:source_repository_url)
  @title = args[:title] if args.key?(:title)
  @update_time = args[:update_time] if args.key?(:update_time)
end