Package org.opensearch.gateway.remote

Class RemoteGlobalMetadataManager

java.lang.Object

org.opensearch.common.remote.AbstractRemoteWritableEntityManager

org.opensearch.gateway.remote.RemoteGlobalMetadataManager

All Implemented Interfaces:

RemoteWritableEntityManager

public class RemoteGlobalMetadataManager
extends AbstractRemoteWritableEntityManager

A Manager which provides APIs to write and read Global Metadata attributes to remote store

Opensearch.internal:

Field Summary

Fields

Modifier and Type	Field	Description
static final int	GLOBAL_METADATA_CURRENT_CODEC_VERSION
static final org.opensearch.common.unit.TimeValue	GLOBAL_METADATA_UPLOAD_TIMEOUT_DEFAULT
static final Setting<org.opensearch.common.unit.TimeValue>	GLOBAL_METADATA_UPLOAD_TIMEOUT_SETTING

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

remoteWritableEntityStores

Method Summary

Modifier and Type	Method	Description
static Map<String,Metadata.Custom>	filterCustoms(Map<String,Metadata.Custom> customs, boolean isRemotePublicationEnabled)
org.opensearch.common.unit.TimeValue	getGlobalMetadataUploadTimeout()
protected org.opensearch.core.action.ActionListener<Object>	getWrappedReadListener(String component, AbstractClusterMetadataWriteableBlobEntity remoteEntity, org.opensearch.core.action.ActionListener<RemoteReadResult> listener)	Returns an ActionListener for handling the read operation for the specified component, remote object, and latched action listener.
protected org.opensearch.core.action.ActionListener<Void>	getWrappedWriteListener(String component, AbstractClusterMetadataWriteableBlobEntity remoteEntity, org.opensearch.core.action.ActionListener<ClusterMetadataManifest.UploadedMetadata> listener)	Returns an ActionListener for handling the write operation for the specified component, remote object, and latched action listener.

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

getStore, readAsync, writeAsync

Methods inherited from class java.lang.Object

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

Field Details

GLOBAL_METADATA_UPLOAD_TIMEOUT_DEFAULT

public static final org.opensearch.common.unit.TimeValue GLOBAL_METADATA_UPLOAD_TIMEOUT_DEFAULT

GLOBAL_METADATA_UPLOAD_TIMEOUT_SETTING

public static final Setting<org.opensearch.common.unit.TimeValue> GLOBAL_METADATA_UPLOAD_TIMEOUT_SETTING

GLOBAL_METADATA_CURRENT_CODEC_VERSION

public static final int GLOBAL_METADATA_CURRENT_CODEC_VERSION

See Also:

• Constant Field Values

Method Details

getWrappedWriteListener

protected org.opensearch.core.action.ActionListener<Void> getWrappedWriteListener(String component,
 AbstractClusterMetadataWriteableBlobEntity remoteEntity,
 org.opensearch.core.action.ActionListener<ClusterMetadataManifest.UploadedMetadata> listener)

Description copied from class: AbstractRemoteWritableEntityManager

Returns an ActionListener for handling the write operation for the specified component, remote object, and latched action listener.

Specified by:

getWrappedWriteListener in class AbstractRemoteWritableEntityManager

Parameters:

component - the component for which the write operation is performed

remoteEntity - the remote object to be written

listener - the listener to be notified when the write operation completes

Returns:

an ActionListener for handling the write operation

getWrappedReadListener

protected org.opensearch.core.action.ActionListener<Object> getWrappedReadListener(String component,
 AbstractClusterMetadataWriteableBlobEntity remoteEntity,
 org.opensearch.core.action.ActionListener<RemoteReadResult> listener)

Description copied from class: AbstractRemoteWritableEntityManager

Returns an ActionListener for handling the read operation for the specified component, remote object, and latched action listener.

Specified by:

getWrappedReadListener in class AbstractRemoteWritableEntityManager

Parameters:

component - the component for which the read operation is performed

remoteEntity - the remote object to be read

listener - the listener to be notified when the read operation completes

Returns:

an ActionListener for handling the read operation

filterCustoms

public static Map<String,Metadata.Custom> filterCustoms(Map<String,Metadata.Custom> customs,
 boolean isRemotePublicationEnabled)

getGlobalMetadataUploadTimeout

public org.opensearch.common.unit.TimeValue getGlobalMetadataUploadTimeout()