java.lang.Object
- org.elasticsearch.index.engine.Segment

All Implemented Interfaces:: Writeable

public class Segment
extends Object
implements Writeable

Nested Class Summary
- Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
  Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields
Modifier and Type	Field	Description
`Map<String,String>`	`attributes`
`boolean`	`committed`
`Boolean`	`compound`
`int`	`delDocCount`
`int`	`docCount`
`long`	`memoryInBytes`
`String`	`mergeId`
`Accountable`	`ramTree`
`boolean`	`search`
`Sort`	`segmentSort`
`long`	`sizeInBytes`
`Version`	`version`

Constructor Summary

Constructors
Constructor Description

Segment(String name)

Segment(StreamInput in)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`Map<String,String>`	`getAttributes()`	Return segment attributes.
`int`	`getDeletedDocs()`
`long`	`getGeneration()`
`long`	`getMemoryInBytes()`	Estimation of the memory usage used by a segment.
`String`	`getMergeId()`	If set, a string representing that the segment is part of a merge, with the value representing the group of segments that represent this merge.
`String`	`getName()`
`int`	`getNumDocs()`
`Sort`	`getSegmentSort()`	Return the sort order of this segment, or null if the segment has no sort.
`ByteSizeValue`	`getSize()`
`Version`	`getVersion()`
`int`	`hashCode()`
`boolean`	`isCommitted()`
`Boolean`	`isCompound()`
`boolean`	`isSearch()`
`String`	`toString()`
`void`	`writeTo(StreamOutput out)`	Write this into the StreamOutput.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

committed
```
public boolean committed
```

search
```
public boolean search
```

sizeInBytes
```
public long sizeInBytes
```

docCount
```
public int docCount
```

delDocCount
```
public int delDocCount
```

version
```
public Version version
```

compound
```
public Boolean compound
```

mergeId
```
public String mergeId
```

memoryInBytes
```
public long memoryInBytes
```

segmentSort
```
public Sort segmentSort
```

ramTree
```
public Accountable ramTree
```

attributes

public Map<String,String> attributes

Constructor Detail

Segment

public Segment(StreamInput in)
        throws IOException

Throws:: IOException

Segment
```
public Segment(String name)
```

Method Detail
- getName
```
public String getName()
```
- getGeneration
```
public long getGeneration()
```
- isCommitted
```
public boolean isCommitted()
```
- isSearch
```
public boolean isSearch()
```
- getNumDocs
```
public int getNumDocs()
```
- getDeletedDocs
```
public int getDeletedDocs()
```
- getSize
```
public ByteSizeValue getSize()
```
- getVersion
```
public Version getVersion()
```
- isCompound
```
@Nullable
public Boolean isCompound()
```
- getMergeId
```
@Nullable
public String getMergeId()
```
  If set, a string representing that the segment is part of a merge, with the value representing the group of segments that represent this merge.
- getMemoryInBytes
```
public long getMemoryInBytes()
```
  Estimation of the memory usage used by a segment.
- getSegmentSort
```
public Sort getSegmentSort()
```
  Return the sort order of this segment, or null if the segment has no sort.
- getAttributes
```
public Map<String,String> getAttributes()
```
  Return segment attributes.
  
  See Also:
  
  SegmentInfo.getAttributes()
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- writeTo
```
public void writeTo(StreamOutput out)
             throws IOException
```
  Description copied from interface: Writeable
  
  Write this into the StreamOutput.
  
  Specified by:
  
  writeTo in interface Writeable
  
  Throws:
  
  IOException
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object

Constructors
Constructor	Description
`Segment(String name)`
`Segment(StreamInput in)`

Class Segment

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

committed

search

sizeInBytes

docCount

delDocCount

version

compound

mergeId

memoryInBytes

segmentSort

ramTree

attributes

Constructor Detail

Segment

Segment

Method Detail

getName

getGeneration

isCommitted

isSearch

getNumDocs

getDeletedDocs

getSize

getVersion

isCompound

getMergeId

getMemoryInBytes

getSegmentSort

getAttributes

equals

hashCode

writeTo

toString