Package org.opensearch.repositories.azure

Class AzureRepository

java.lang.Object

org.opensearch.common.lifecycle.AbstractLifecycleComponent

org.opensearch.repositories.blobstore.BlobStoreRepository

org.opensearch.repositories.blobstore.MeteredBlobStoreRepository

org.opensearch.repositories.azure.AzureRepository

All Implemented Interfaces:

Closeable, AutoCloseable, org.opensearch.common.lease.Releasable, org.opensearch.common.lifecycle.LifecycleComponent, Repository

public class AzureRepository
extends MeteredBlobStoreRepository

Azure file system implementation of the BlobStoreRepository

Azure file system repository supports the following settings:

container

Azure container name. Defaults to opensearch-snapshots

base_path

Specifies the path within bucket to repository data. Defaults to root directory.

chunk_size

Large file can be divided into chunks. This parameter specifies the chunk size. Defaults to 64mb.

compress

If set to true metadata files will be stored compressed. Defaults to false.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AzureRepository.Repository

Nested classes/interfaces inherited from interface org.opensearch.repositories.Repository

Repository.Factory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE

Fields inherited from class org.opensearch.repositories.blobstore.BlobStoreRepository

ALLOW_CONCURRENT_MODIFICATION, BUFFER_SIZE_SETTING, bufferSize, CACHE_REPOSITORY_DATA, clusterService, COMPRESS_SETTING, COMPRESSION_TYPE_SETTING, GLOBAL_METADATA_FORMAT, INDEX_FILE_PREFIX, INDEX_LATEST_BLOB, INDEX_METADATA_FORMAT, INDEX_SHARD_SNAPSHOT_FORMAT, INDEX_SHARD_SNAPSHOTS_FORMAT, MAX_SNAPSHOT_SHARD_BLOB_DELETE_BATCH_SIZE, metadata, METADATA_NAME_FORMAT, METADATA_PREFIX, READONLY_SETTING, REMOTE_STORE_INDEX_SHALLOW_COPY, REMOTE_STORE_SHARD_SHALLOW_COPY_SNAPSHOT_FORMAT, SHALLOW_SNAPSHOT_NAME_FORMAT, SHALLOW_SNAPSHOT_PREFIX, SNAPSHOT_FORMAT, SNAPSHOT_NAME_FORMAT, SNAPSHOT_PREFIX, SUPPORT_URL_REPO, supportURLRepo, SYSTEM_REPOSITORY_SETTING, threadPool, VIRTUAL_DATA_BLOB_PREFIX

Fields inherited from class org.opensearch.common.lifecycle.AbstractLifecycleComponent

lifecycle

Constructor Summary

Constructors

Constructor	Description
AzureRepository(RepositoryMetadata metadata, org.opensearch.core.xcontent.NamedXContentRegistry namedXContentRegistry, AzureStorageService storageService, ClusterService clusterService, RecoverySettings recoverySettings)

Method Summary

Modifier and Type	Method	Description
BlobPath	basePath()
protected org.opensearch.core.common.unit.ByteSizeValue	chunkSize()
protected AzureBlobStore	createBlobStore()
protected BlobStore	getBlobStore()
List<Setting<?>>	getRestrictedSystemRepositorySettings()
boolean	isReadOnly()

Methods inherited from class org.opensearch.repositories.blobstore.MeteredBlobStoreRepository

reload, statsSnapshot, statsSnapshotForArchival

Methods inherited from class org.opensearch.repositories.blobstore.BlobStoreRepository

assertSnapshotOrGenericThread, blobContainer, blobStore, cleanup, cloneRemoteStoreIndexShardSnapshot, cloneShardSnapshot, deleteSnapshots, deleteSnapshotsAndReleaseLockFiles, doClose, doStart, doStop, endVerification, executeConsistentStateUpdate, finalizeSnapshot, getCompressor, getMetadata, getNamedXContentRegistry, getRemoteDownloadThrottleTimeInNanos, getRemoteStoreShallowCopyShardMetadata, getRemoteUploadThrottleTimeInNanos, getRepositoryData, getRestoreThrottleTimeInNanos, getShardSnapshotStatus, getSnapshotGlobalMetadata, getSnapshotIndexMetaData, getSnapshotInfo, getSnapshotThrottleTimeInNanos, initializeSnapshot, isCompress, isSystemRepository, loadShardSnapshot, maybeRateLimitRemoteDownloadTransfers, maybeRateLimitRemoteUploadTransfers, maybeRateLimitRestores, maybeRateLimitSnapshots, restoreShard, shardContainer, snapshotRemoteStoreIndexShard, snapshotShard, startVerification, stats, threadPool, toString, updateState, verify, writeIndexGen

Methods inherited from class org.opensearch.common.lifecycle.AbstractLifecycleComponent

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.common.lifecycle.LifecycleComponent

addLifecycleListener, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from interface org.opensearch.common.lease.Releasable

close

Methods inherited from interface org.opensearch.repositories.Repository

adaptUserMetadata, isReloadable, validateMetadata

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

Constructor Details

AzureRepository

public AzureRepository(RepositoryMetadata metadata,
 org.opensearch.core.xcontent.NamedXContentRegistry namedXContentRegistry,
 AzureStorageService storageService,
 ClusterService clusterService,
 RecoverySettings recoverySettings)

Method Details

getBlobStore

protected BlobStore getBlobStore()

Overrides:

getBlobStore in class BlobStoreRepository

createBlobStore

protected AzureBlobStore createBlobStore()

Specified by:

createBlobStore in class BlobStoreRepository

basePath

public BlobPath basePath()

Specified by:

basePath in class BlobStoreRepository

chunkSize

protected org.opensearch.core.common.unit.ByteSizeValue chunkSize()

Overrides:

chunkSize in class BlobStoreRepository

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface Repository

Overrides:

isReadOnly in class BlobStoreRepository

getRestrictedSystemRepositorySettings

public List<Setting<?>> getRestrictedSystemRepositorySettings()

Specified by:

getRestrictedSystemRepositorySettings in interface Repository

Overrides:

getRestrictedSystemRepositorySettings in class BlobStoreRepository