Class: Google::Apis::CloudsearchV1::ItemMetadata
- Inherits:
-
Object
- Object
- Google::Apis::CloudsearchV1::ItemMetadata
- 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
-
#container_name ⇒ String
The name of the container for this item.
-
#content_language ⇒ String
The BCP-47 language code for the item, such as "en-US" or "sr-Latn".
-
#create_time ⇒ String
The time when the item was created in the source repository.
-
#hash_prop ⇒ String
Hashing value provided by the API caller.
-
#interactions ⇒ Array<Google::Apis::CloudsearchV1::Interaction>
A list of interactions for the item.
-
#keywords ⇒ Array<String>
Additional keywords or phrases that should match the item.
-
#mime_type ⇒ String
The original mime-type of ItemContent.content in the source repository.
-
#object_type ⇒ String
The type of the item.
-
#search_quality_metadata ⇒ Google::Apis::CloudsearchV1::SearchQualityMetadata
Additional search quality metadata of the item.
-
#source_repository_url ⇒ String
Link to the source repository serving the data.
-
#title ⇒ String
The title of the item.
-
#update_time ⇒ String
The time when the item was last modified in the source repository.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ItemMetadata
constructor
A new instance of ItemMetadata.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ ItemMetadata
Returns a new instance of ItemMetadata
1910 1911 1912 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1910 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
1829 1830 1831 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1829 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
1837 1838 1839 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1837 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
1842 1843 1844 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1842 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
1851 1852 1853 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1851 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
1858 1859 1860 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1858 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
1866 1867 1868 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1866 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
1874 1875 1876 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1874 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
1884 1885 1886 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1884 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
1889 1890 1891 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1889 def @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
1896 1897 1898 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1896 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
1903 1904 1905 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1903 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
1908 1909 1910 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1908 def update_time @update_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1915 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 |