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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudsearch_v1/classes.rb,
generated/google/apis/cloudsearch_v1/representations.rb,
generated/google/apis/cloudsearch_v1/representations.rb

Overview

Available metadata fields for the item.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ItemMetadata

Returns a new instance of ItemMetadata.



2029
2030
2031
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2029

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) 


1948
1949
1950
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1948

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) 


1956
1957
1958
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1956

def content_language
  @content_language
end

#create_time ⇒ String

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

Returns:

  • (String) 


1961
1962
1963
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1961

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) 


1970
1971
1972
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1970

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:



1977
1978
1979
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1977

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


1985
1986
1987
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1985

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) 


1993
1994
1995
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1993

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) 


2003
2004
2005
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2003

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:



2008
2009
2010
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2008

def search_quality_metadata
  @search_quality_metadata
end

#source_repository_url ⇒ String

Link to the source repository serving the data. Search results apply this link to the title. The maximum length is 2048 characters. Corresponds to the JSON property sourceRepositoryUrl

Returns:

  • (String) 


2015
2016
2017
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2015

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) 


2022
2023
2024
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2022

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) 


2027
2028
2029
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2027

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2034

def update!(**args)
  @container_name = args[:container_name] if args.key?(:container_name)
  @content_language = args[:content_language] if args.key?(:content_language)
  @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