Package org.opensearch.gateway.remote.model

Class RemoteCustomMetadata

java.lang.Object

org.opensearch.common.remote.RemoteWriteableBlobEntity<Metadata.Custom>

org.opensearch.common.remote.AbstractClusterMetadataWriteableBlobEntity<Metadata.Custom>

org.opensearch.gateway.remote.model.RemoteCustomMetadata

All Implemented Interfaces:

RemoteWriteableEntity<Metadata.Custom>

public class RemoteCustomMetadata
extends AbstractClusterMetadataWriteableBlobEntity<Metadata.Custom>

Wrapper class for uploading/downloading Metadata.Custom to/from remote blob store

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CUSTOM_DELIMITER
static final String	CUSTOM_METADATA
final ChecksumWritableBlobStoreFormat<Metadata.Custom>	customBlobStoreFormat

Fields inherited from class org.opensearch.common.remote.AbstractClusterMetadataWriteableBlobEntity

namedXContentRegistry

Fields inherited from class org.opensearch.common.remote.RemoteWriteableBlobEntity

blobFileName, blobName

Constructor Summary

Constructors

Constructor	Description
RemoteCustomMetadata(String blobName, String customType, String clusterUUID, org.opensearch.core.compress.Compressor compressor, org.opensearch.core.common.io.stream.NamedWriteableRegistry namedWriteableRegistry, org.opensearch.Version version)
RemoteCustomMetadata(Metadata.Custom custom, String customType, long metadataVersion, String clusterUUID, org.opensearch.core.compress.Compressor compressor, org.opensearch.core.common.io.stream.NamedWriteableRegistry namedWriteableRegistry)

Method Summary

Modifier and Type	Method	Description
Metadata.Custom	deserialize(InputStream inputStream)
String	generateBlobFileName()
BlobPathParameters	getBlobPathParameters()
String	getType()
ClusterMetadataManifest.UploadedMetadata	getUploadedMetadata()
static Metadata.Custom	readFrom(org.opensearch.core.common.io.stream.StreamInput streamInput, org.opensearch.core.common.io.stream.NamedWriteableRegistry namedWriteableRegistry, String customType)
InputStream	serialize()

Methods inherited from class org.opensearch.common.remote.AbstractClusterMetadataWriteableBlobEntity

getNamedXContentRegistry

Methods inherited from class org.opensearch.common.remote.RemoteWriteableBlobEntity

clusterUUID, getBlobFileName, getBlobPathTokens, getCompressor, getFullBlobName, getPrefixedPath, setFullBlobName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CUSTOM_METADATA

public static final String CUSTOM_METADATA

See Also:

• Constant Field Values

CUSTOM_DELIMITER

public static final String CUSTOM_DELIMITER

See Also:

• Constant Field Values

customBlobStoreFormat

public final ChecksumWritableBlobStoreFormat<Metadata.Custom> customBlobStoreFormat

Constructor Details

RemoteCustomMetadata

public RemoteCustomMetadata(Metadata.Custom custom,
 String customType,
 long metadataVersion,
 String clusterUUID,
 org.opensearch.core.compress.Compressor compressor,
 org.opensearch.core.common.io.stream.NamedWriteableRegistry namedWriteableRegistry)

RemoteCustomMetadata

public RemoteCustomMetadata(String blobName,
 String customType,
 String clusterUUID,
 org.opensearch.core.compress.Compressor compressor,
 org.opensearch.core.common.io.stream.NamedWriteableRegistry namedWriteableRegistry,
 org.opensearch.Version version)

Method Details

getBlobPathParameters

public BlobPathParameters getBlobPathParameters()

Specified by:

getBlobPathParameters in class RemoteWriteableBlobEntity<Metadata.Custom>

getType

public String getType()

Specified by:

getType in class RemoteWriteableBlobEntity<Metadata.Custom>

generateBlobFileName

public String generateBlobFileName()

Specified by:

generateBlobFileName in class RemoteWriteableBlobEntity<Metadata.Custom>

serialize

public InputStream serialize()
                      throws IOException

Returns:

An InputStream created by serializing the entity T

Throws:

IOException - Exception encountered while serialization

deserialize

public Metadata.Custom deserialize(InputStream inputStream)
                            throws IOException

Parameters:

inputStream - The InputStream which is used to read the serialized entity

Returns:

The entity T after deserialization

Throws:

IOException - Exception encountered while deserialization

getUploadedMetadata

public ClusterMetadataManifest.UploadedMetadata getUploadedMetadata()

Specified by:

getUploadedMetadata in class AbstractClusterMetadataWriteableBlobEntity<Metadata.Custom>

readFrom

public static Metadata.Custom readFrom(org.opensearch.core.common.io.stream.StreamInput streamInput,
 org.opensearch.core.common.io.stream.NamedWriteableRegistry namedWriteableRegistry,
 String customType)
                                throws IOException

Throws:

IOException