Class Attachment

An attachment indexed with an ingest pipeline using the ingest-attachment plugin. Convenience class for working with attachment fields.

Inheritance

object

Attachment

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public class Attachment

Properties

Author

The author

Declaration

[DataMember(Name = "author")]
public string Author { get; set; }

Property Value

Type	Description
string

ContainsMetadata

Whether the attachment contains explicit metadata in addition to the content. Used at indexing time to determine the serialized form of the attachment.

Declaration

[IgnoreDataMember]
public bool ContainsMetadata { get; }

Property Value

Type	Description
bool

Content

The base64 encoded content. Can be explicitly set

Declaration

[DataMember(Name = "content")]
public string Content { get; set; }

Property Value

Type	Description
string

ContentLength

The length of the content before text extraction.

Declaration

[DataMember(Name = "content_length")]
public long? ContentLength { get; set; }

Property Value

Type	Description
long?

ContentType

The content type of the attachment. Can be explicitly set

Declaration

[DataMember(Name = "content_type")]
public string ContentType { get; set; }

Property Value

Type	Description
string

Date

The date of the attachment.

Declaration

[DataMember(Name = "date")]
public DateTime? Date { get; set; }

Property Value

Type	Description
DateTime?

DetectLanguage

Detect the language of the attachment. Language detection is disabled by default.

Declaration

[DataMember(Name = "detect_language")]
public bool? DetectLanguage { get; set; }

Property Value

Type	Description
bool?

IndexedCharacters

Determines how many characters are extracted when indexing the content. By default, 100000 characters are extracted when indexing the content. -1 can be set to extract all text, but note that all the text needs to be allowed to be represented in memory

Declaration

[DataMember(Name = "indexed_chars")]
public long? IndexedCharacters { get; set; }

Property Value

Type	Description
long?

Keywords

The keywords in the attachment.

Declaration

[DataMember(Name = "keywords")]
public string Keywords { get; set; }

Property Value

Type	Description
string

Language

The language of the attachment. Can be explicitly set.

Declaration

[DataMember(Name = "language")]
public string Language { get; set; }

Property Value

Type	Description
string

Name

The name of the attachment. Can be explicitly set

Declaration

[DataMember(Name = "name")]
public string Name { get; set; }

Property Value

Type	Description
string

Title

The title of the attachment.

Declaration

[DataMember(Name = "title")]
public string Title { get; set; }

Property Value

Type	Description
string

Extension Methods

SuffixExtensions.Suffix(object, string)