Package org.opensearch.gateway.remote.model

Class RemoteTemplatesMetadata

java.lang.Object

org.opensearch.common.remote.RemoteWriteableBlobEntity<TemplatesMetadata>

org.opensearch.common.remote.AbstractClusterMetadataWriteableBlobEntity<TemplatesMetadata>

org.opensearch.gateway.remote.model.RemoteTemplatesMetadata

All Implemented Interfaces:

RemoteWriteableEntity<TemplatesMetadata>

public class RemoteTemplatesMetadata
extends AbstractClusterMetadataWriteableBlobEntity<TemplatesMetadata>

Wrapper class for uploading/downloading TemplatesMetadata to/from remote blob store

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TEMPLATES_METADATA
static final ChecksumBlobStoreFormat<TemplatesMetadata>	TEMPLATES_METADATA_FORMAT

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
RemoteTemplatesMetadata(String blobName, String clusterUUID, org.opensearch.core.compress.Compressor compressor, org.opensearch.core.xcontent.NamedXContentRegistry namedXContentRegistry)
RemoteTemplatesMetadata(TemplatesMetadata templatesMetadata, long metadataVersion, String clusterUUID, org.opensearch.core.compress.Compressor compressor, org.opensearch.core.xcontent.NamedXContentRegistry namedXContentRegistry)

Method Summary

Modifier and Type	Method	Description
TemplatesMetadata	deserialize(InputStream inputStream)
String	generateBlobFileName()
BlobPathParameters	getBlobPathParameters()
String	getType()
ClusterMetadataManifest.UploadedMetadata	getUploadedMetadata()
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

TEMPLATES_METADATA

public static final String TEMPLATES_METADATA

See Also:

• Constant Field Values

TEMPLATES_METADATA_FORMAT

public static final ChecksumBlobStoreFormat<TemplatesMetadata> TEMPLATES_METADATA_FORMAT

Constructor Details

RemoteTemplatesMetadata

public RemoteTemplatesMetadata(TemplatesMetadata templatesMetadata,
 long metadataVersion,
 String clusterUUID,
 org.opensearch.core.compress.Compressor compressor,
 org.opensearch.core.xcontent.NamedXContentRegistry namedXContentRegistry)

RemoteTemplatesMetadata

public RemoteTemplatesMetadata(String blobName,
 String clusterUUID,
 org.opensearch.core.compress.Compressor compressor,
 org.opensearch.core.xcontent.NamedXContentRegistry namedXContentRegistry)

Method Details

getBlobPathParameters

public BlobPathParameters getBlobPathParameters()

Specified by:

getBlobPathParameters in class RemoteWriteableBlobEntity<TemplatesMetadata>

getType

public String getType()

Specified by:

getType in class RemoteWriteableBlobEntity<TemplatesMetadata>

generateBlobFileName

public String generateBlobFileName()

Specified by:

generateBlobFileName in class RemoteWriteableBlobEntity<TemplatesMetadata>

serialize

public InputStream serialize()
                      throws IOException

Returns:

An InputStream created by serializing the entity T

Throws:

IOException - Exception encountered while serialization

deserialize

public TemplatesMetadata 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<TemplatesMetadata>