Package org.opensearch.cluster.metadata

Class AliasMetadata

java.lang.Object

org.opensearch.cluster.AbstractDiffable<AliasMetadata>

org.opensearch.cluster.metadata.AliasMetadata

All Implemented Interfaces:

Diffable<AliasMetadata>, Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment

public class AliasMetadata
extends AbstractDiffable<AliasMetadata>
implements org.opensearch.common.xcontent.ToXContentFragment

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AliasMetadata.Builder

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

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

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
AliasMetadata(StreamInput in)

Method Summary

Modifier and Type	Method	Description
java.lang.String	alias()
static AliasMetadata.Builder	builder(java.lang.String alias)
boolean	equals(java.lang.Object o)
CompressedXContent	filter()
boolean	filteringRequired()
java.lang.String	getAlias()
CompressedXContent	getFilter()
java.lang.String	getIndexRouting()
java.lang.String	getSearchRouting()
int	hashCode()
java.lang.String	indexRouting()
java.lang.Boolean	isHidden()
static AliasMetadata	newAliasMetadata(AliasMetadata aliasMetadata, java.lang.String newAlias)	Creates a new AliasMetadata instance with same content as the given one, but with a different alias name
static AliasMetadata.Builder	newAliasMetadataBuilder(java.lang.String alias)
static Diff<AliasMetadata>	readDiffFrom(StreamInput in)
java.lang.String	searchRouting()
java.util.Set<java.lang.String>	searchRoutingValues()
java.lang.String	toString()
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
java.lang.Boolean	writeIndex()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.opensearch.cluster.AbstractDiffable

diff, readDiffFrom

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

isFragment

Constructor Details

AliasMetadata

public AliasMetadata(StreamInput in) throws java.io.IOException

Throws:

java.io.IOException

Method Details

alias

public java.lang.String alias()

getAlias

public java.lang.String getAlias()

filter

public CompressedXContent filter()

getFilter

public CompressedXContent getFilter()

filteringRequired

public boolean filteringRequired()

getSearchRouting

public java.lang.String getSearchRouting()

searchRouting

public java.lang.String searchRouting()

getIndexRouting

public java.lang.String getIndexRouting()

indexRouting

public java.lang.String indexRouting()

searchRoutingValues

public java.util.Set<java.lang.String> searchRoutingValues()

writeIndex

public java.lang.Boolean writeIndex()

isHidden

@Nullable public java.lang.Boolean isHidden()

builder

public static AliasMetadata.Builder builder(java.lang.String alias)

newAliasMetadataBuilder

public static AliasMetadata.Builder newAliasMetadataBuilder(java.lang.String alias)

newAliasMetadata

public static AliasMetadata newAliasMetadata(AliasMetadata aliasMetadata, java.lang.String newAlias)

Creates a new AliasMetadata instance with same content as the given one, but with a different alias name

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

writeTo

public void writeTo(StreamOutput out) throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

readDiffFrom

public static Diff<AliasMetadata> readDiffFrom(StreamInput in) throws java.io.IOException

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Throws:

java.io.IOException