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

Constructor Details

#initialize(**args) ⇒ ItemMetadata

Returns a new instance of ItemMetadata.



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

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) 


1882
1883
1884
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1882

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) 


1889
1890
1891
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1889

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) 


1894
1895
1896
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1894

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) 


1900
1901
1902
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1900

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:



1907
1908
1909
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1907

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


1914
1915
1916
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1914

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) 


1920
1921
1922
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1920

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) 


1929
1930
1931
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1929

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:



1934
1935
1936
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1934

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. Whitespace or special characters may cause Cloud Search 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) 


1942
1943
1944
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1942

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) 


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

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) 


1953
1954
1955
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1953

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1960

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