Show / Hide Table of Contents

Class ItemMetadata

Available metadata fields for the item.

Inheritance
object
ItemMetadata
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudSearch.v1.Data
Assembly: Google.Apis.CloudSearch.v1.dll
Syntax
public class ItemMetadata : IDirectResponseSchema

Properties

ContainerName

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.

Declaration
[JsonProperty("containerName")]
public virtual string ContainerName { get; set; }
Property Value
Type Description
string

ContentLanguage

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.

Declaration
[JsonProperty("contentLanguage")]
public virtual string ContentLanguage { get; set; }
Property Value
Type Description
string

ContextAttributes

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.

Declaration
[JsonProperty("contextAttributes")]
public virtual IList<ContextAttribute> ContextAttributes { get; set; }
Property Value
Type Description
IList<ContextAttribute>

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

The time when the item was created in the source repository.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Hash

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.

Declaration
[JsonProperty("hash")]
public virtual string Hash { get; set; }
Property Value
Type Description
string

Interactions

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.

Declaration
[JsonProperty("interactions")]
public virtual IList<Interaction> Interactions { get; set; }
Property Value
Type Description
IList<Interaction>

Keywords

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.

Declaration
[JsonProperty("keywords")]
public virtual IList<string> Keywords { get; set; }
Property Value
Type Description
IList<string>

MimeType

The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.

Declaration
[JsonProperty("mimeType")]
public virtual string MimeType { get; set; }
Property Value
Type Description
string

ObjectType

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.

Declaration
[JsonProperty("objectType")]
public virtual string ObjectType { get; set; }
Property Value
Type Description
string

SearchQualityMetadata

Additional search quality metadata of the item

Declaration
[JsonProperty("searchQualityMetadata")]
public virtual SearchQualityMetadata SearchQualityMetadata { get; set; }
Property Value
Type Description
SearchQualityMetadata

SourceRepositoryUrl

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.

Declaration
[JsonProperty("sourceRepositoryUrl")]
public virtual string SourceRepositoryUrl { get; set; }
Property Value
Type Description
string

Title

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

Declaration
[JsonProperty("title")]
public virtual string Title { get; set; }
Property Value
Type Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

The time when the item was last modified in the source repository.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX