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.



11954
11955
11956
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11954

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) 


11874
11875
11876
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11874

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) 


11881
11882
11883
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11881

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:



11888
11889
11890
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11888

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) 


11893
11894
11895
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11893

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) 


11899
11900
11901
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11899

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:



11906
11907
11908
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11906

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


11913
11914
11915
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11913

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) 


11919
11920
11921
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11919

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) 


11928
11929
11930
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11928

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:



11933
11934
11935
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11933

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) 


11941
11942
11943
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11941

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) 


11947
11948
11949
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11947

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) 


11952
11953
11954
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11952

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 11959

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