Uses of Class org.apache.hadoop.hdfs.server.federation.store.records.BaseRecord (Apache Hadoop HDFS-RBF 3.5.0 API)
Description: use: package: org.apache.hadoop.hdfs.server.federation.store.records, class: BaseRecord

# Uses of Class
org.apache.hadoop.hdfs.server.federation.store.records.BaseRecord

Packages that use BaseRecord
Package
Description
org.apache.hadoop.hdfs.server.federation.store
The federation state store tracks persistent values that are shared between multiple routers.
org.apache.hadoop.hdfs.server.federation.store.driver
The state store uses modular data storage classes derived from StateStoreDriver to handle querying, updating and deleting data records.
org.apache.hadoop.hdfs.server.federation.store.driver.impl
Implementations of state store data providers/drivers.
org.apache.hadoop.hdfs.server.federation.store.records
Contains the abstract definitions of the state store data records.
org.apache.hadoop.hdfs.server.federation.store.records.impl.pb
The protobuf implementations of state store data records defined in the org.apache.hadoop.hdfs.server.federation.store.records package.

- ## Uses of BaseRecord in org.apache.hadoop.hdfs.server.federation.store

  Classes in org.apache.hadoop.hdfs.server.federation.store with type parameters of type BaseRecord
  Modifier and Type
  Class
  Description
  `class`
  `CachedRecordStore<R extends BaseRecord>`
  Record store that takes care of caching the records in memory.
  `class`
  `RecordStore<R extends BaseRecord>`
  Store records in the State Store.
  Methods in org.apache.hadoop.hdfs.server.federation.store with type parameters of type BaseRecord
  Modifier and Type
  Method
  Description
  `static <T extends BaseRecord>
  List<T>`
  StateStoreUtils.`filterMultiple(Query<T> query, Iterable<T> records)`
  Filters a list of records to find all records matching the query.
  `static <T extends BaseRecord>
  Class<? extends BaseRecord>`
  StateStoreUtils.`getRecordClass(Class<T> clazz)`
  Get the base class for a record class.
  `static <T extends BaseRecord>
  Class<? extends BaseRecord>`
  StateStoreUtils.`getRecordClass(T record)`
  Get the base class for a record.
  `static <T extends BaseRecord>
  String`
  StateStoreUtils.`getRecordName(Class<T> clazz)`
  Get the base class name for a record.
  `<T extends RecordStore<? extends BaseRecord>>
  List<T>`
  StateStoreService.`getRecordStores()`
  Get the list of all RecordStores.
  Methods in org.apache.hadoop.hdfs.server.federation.store that return types with arguments of type BaseRecord
  Modifier and Type
  Method
  Description
  `static <T extends BaseRecord>
  Class<? extends BaseRecord>`
  StateStoreUtils.`getRecordClass(Class<T> clazz)`
  Get the base class for a record class.
  `static <T extends BaseRecord>
  Class<? extends BaseRecord>`
  StateStoreUtils.`getRecordClass(T record)`
  Get the base class for a record.
  `Collection<Class<? extends BaseRecord>>`
  StateStoreService.`getSupportedRecords()`
  List of records supported by this State Store.

- ## Uses of BaseRecord in org.apache.hadoop.hdfs.server.federation.store.driver

  Methods in org.apache.hadoop.hdfs.server.federation.store.driver with type parameters of type BaseRecord
  Modifier and Type
  Method
  Description
  `abstract <T extends BaseRecord>
  T`
  StateStoreSerializer.`deserialize(byte[] byteArray, Class<T> clazz)`
  Deserialize a bytes array into a record.
  `abstract <T extends BaseRecord>
  T`
  StateStoreSerializer.`deserialize(String data, Class<T> clazz)`
  Deserialize a string into a record.
  `<T extends BaseRecord>
  QueryResult<T>`
  StateStoreRecordOperations.`get(Class<T> clazz)`
  Get all records of the requested record class from the data store.
  `<T extends BaseRecord>
  T`
  StateStoreRecordOperations.`get(Class<T> clazz, Query<T> query)`
  Get a single record from the store that matches the query.
  `<T extends BaseRecord>
  List<T>`
  StateStoreRecordOperations.`getMultiple(Class<T> clazz, Query<T> query)`
  Get multiple records from the store that match a query.
  `<R extends BaseRecord>
  List<R>`
  StateStoreDriver.`handleOverwriteAndDelete(List<R> commitRecords, List<R> deleteRecords)`
  Try to overwrite records in commitRecords and remove records in deleteRecords.
  `abstract <T extends BaseRecord>
  boolean`
  StateStoreDriver.`initRecordStorage(String className, Class<T> clazz)`
  Initialize storage for a single record class.
  `<T extends BaseRecord>
  boolean`
  StateStoreRecordOperations.`put(T record, boolean allowUpdate, boolean errorIfExists)`
  Creates a single record.
  `<T extends BaseRecord>
  StateStoreOperationResult`
  StateStoreRecordOperations.`putAll(List<T> records, boolean allowUpdate, boolean errorIfExists)`
  Creates multiple records.
  `<T extends BaseRecord>
  Map<Query<T>,Integer>`
  StateStoreRecordOperations.`remove(Class<T> clazz, List<Query<T>> queries)`
  Remove all records of a specific class that match any query in a list of queries.
  `<T extends BaseRecord>
  int`
  StateStoreRecordOperations.`remove(Class<T> clazz, Query<T> query)`
  Remove multiple records of a specific class that match a query.
  `<T extends BaseRecord>
  boolean`
  StateStoreRecordOperations.`remove(T record)`
  Remove a single record.
  `<T extends BaseRecord>
  boolean`
  StateStoreRecordOperations.`removeAll(Class<T> clazz)`
  Remove all records of this class from the store.
  `<T extends BaseRecord>
  Map<T,Boolean>`
  StateStoreRecordOperations.`removeMultiple(List<T> records)`
  Remove multiple records.
  Methods in org.apache.hadoop.hdfs.server.federation.store.driver with parameters of type BaseRecord
  Modifier and Type
  Method
  Description
  `abstract byte[]`
  StateStoreSerializer.`serialize(BaseRecord record)`
  Serialize a record into a byte array.
  `abstract String`
  StateStoreSerializer.`serializeString(BaseRecord record)`
  Serialize a record into a string.
  Method parameters in org.apache.hadoop.hdfs.server.federation.store.driver with type arguments of type BaseRecord
  Modifier and Type
  Method
  Description
  `boolean`
  StateStoreDriver.`init(org.apache.hadoop.conf.Configuration config, String id, Collection<Class<? extends BaseRecord>> records, StateStoreMetrics stateStoreMetrics)`
  Initialize the state store connection.

- ## Uses of BaseRecord in org.apache.hadoop.hdfs.server.federation.store.driver.impl

  Methods in org.apache.hadoop.hdfs.server.federation.store.driver.impl with type parameters of type BaseRecord
  Modifier and Type
  Method
  Description
  `<T extends BaseRecord>
  T`
  StateStoreSerializerPBImpl.`deserialize(byte[] byteArray, Class<T> clazz)`
  `<T extends BaseRecord>
  T`
  StateStoreSerializerPBImpl.`deserialize(String data, Class<T> clazz)`
  `<T extends BaseRecord>
  T`
  StateStoreBaseImpl.`get(Class<T> clazz, Query<T> query)`
  `<T extends BaseRecord>
  QueryResult<T>`
  StateStoreFileBaseImpl.`get(Class<T> clazz)`
  `<T extends BaseRecord>
  QueryResult<T>`
  StateStoreMySQLImpl.`get(Class<T> clazz)`
  `<T extends BaseRecord>
  QueryResult<T>`
  StateStoreZooKeeperImpl.`get(Class<T> clazz)`
  `<T extends BaseRecord>
  List<T>`
  StateStoreBaseImpl.`getMultiple(Class<T> clazz, Query<T> query)`
  `protected abstract <T extends BaseRecord>
  BufferedReader`
  StateStoreFileBaseImpl.`getReader(String path)`
  Get the reader of a record for the file system.
  `protected <T extends BaseRecord>
  BufferedReader`
  StateStoreFileImpl.`getReader(String filename)`
  `protected <T extends BaseRecord>
  BufferedReader`
  StateStoreFileSystemImpl.`getReader(String pathName)`
  `abstract <T extends BaseRecord>
  BufferedWriter`
  StateStoreFileBaseImpl.`getWriter(String path)`
  Get the writer of a record for the file system.
  `<T extends BaseRecord>
  BufferedWriter`
  StateStoreFileImpl.`getWriter(String filename)`
  `<T extends BaseRecord>
  BufferedWriter`
  StateStoreFileSystemImpl.`getWriter(String pathName)`
  `<T extends BaseRecord>
  boolean`
  StateStoreFileBaseImpl.`initRecordStorage(String className, Class<T> recordClass)`
  `<T extends BaseRecord>
  boolean`
  StateStoreMySQLImpl.`initRecordStorage(String className, Class<T> clazz)`
  `<T extends BaseRecord>
  boolean`
  StateStoreZooKeeperImpl.`initRecordStorage(String className, Class<T> clazz)`
  `protected <T extends BaseRecord>
  T`
  StateStoreSerializableImpl.`newRecord(String data, Class<T> clazz, boolean includeDates)`
  Creates a record from an input data string.
  `<T extends BaseRecord>
  boolean`
  StateStoreBaseImpl.`put(T record, boolean allowUpdate, boolean errorIfExists)`
  `<T extends BaseRecord>
  StateStoreOperationResult`
  StateStoreFileBaseImpl.`putAll(List<T> records, boolean allowUpdate, boolean errorIfExists)`
  `<T extends BaseRecord>
  StateStoreOperationResult`
  StateStoreMySQLImpl.`putAll(List<T> records, boolean allowUpdate, boolean errorIfExists)`
  `<T extends BaseRecord>
  StateStoreOperationResult`
  StateStoreZooKeeperImpl.`putAll(List<T> records, boolean update, boolean error)`
  `<T extends BaseRecord>
  Map<Query<T>,Integer>`
  StateStoreBaseImpl.`remove(Class<T> clazz, List<Query<T>> queries)`
  `<T extends BaseRecord>
  boolean`
  StateStoreBaseImpl.`remove(T record)`
  `<T extends BaseRecord>
  int`
  StateStoreFileBaseImpl.`remove(Class<T> clazz, Query<T> query)`
  `<T extends BaseRecord>
  int`
  StateStoreMySQLImpl.`remove(Class<T> clazz, Query<T> query)`
  `<T extends BaseRecord>
  Map<Query<T>,Integer>`
  StateStoreZooKeeperImpl.`remove(Class<T> clazz, List<Query<T>> queries)`
  `<T extends BaseRecord>
  int`
  StateStoreZooKeeperImpl.`remove(Class<T> clazz, Query<T> query)`
  `<T extends BaseRecord>
  boolean`
  StateStoreFileBaseImpl.`removeAll(Class<T> clazz)`
  `<T extends BaseRecord>
  boolean`
  StateStoreMySQLImpl.`removeAll(Class<T> clazz)`
  `<T extends BaseRecord>
  boolean`
  StateStoreZooKeeperImpl.`removeAll(Class<T> clazz)`
  `<T extends BaseRecord>
  Map<T,Boolean>`
  StateStoreBaseImpl.`removeMultiple(List<T> records)`
  `protected <T extends BaseRecord>
  byte[]`
  StateStoreSerializableImpl.`serialize(T record)`
  Serialize a record using the serializer.
  `protected <T extends BaseRecord>
  String`
  StateStoreSerializableImpl.`serializeString(T record)`
  Serialize a record using the serializer.
  Methods in org.apache.hadoop.hdfs.server.federation.store.driver.impl with parameters of type BaseRecord
  Modifier and Type
  Method
  Description
  `protected static String`
  StateStoreSerializableImpl.`getPrimaryKey(BaseRecord record)`
  Get the primary key for a record.
  `byte[]`
  StateStoreSerializerPBImpl.`serialize(BaseRecord record)`
  `String`
  StateStoreSerializerPBImpl.`serializeString(BaseRecord record)`
  Method parameters in org.apache.hadoop.hdfs.server.federation.store.driver.impl with type arguments of type BaseRecord
  Modifier and Type
  Method
  Description
  `boolean`
  StateStoreSerializableImpl.`init(org.apache.hadoop.conf.Configuration config, String id, Collection<Class<? extends BaseRecord>> records, StateStoreMetrics metrics)`

- ## Uses of BaseRecord in org.apache.hadoop.hdfs.server.federation.store.records

  Classes in org.apache.hadoop.hdfs.server.federation.store.records with type parameters of type BaseRecord
  Modifier and Type
  Class
  Description
  `class`
  `Query<T extends BaseRecord>`
  Check if a record matches a query.
  `class`
  `QueryResult<T extends BaseRecord>`
  Encapsulates a state store query result that includes a set of records and a time stamp for the result.
  Subclasses of BaseRecord in org.apache.hadoop.hdfs.server.federation.store.records
  Modifier and Type
  Class
  Description
  `class`
  `DisabledNameservice`
  Data record indicating a specific name service ID has been disabled and is no longer valid.
  `class`
  `MembershipState`
  Data schema for storing NN registration information in the `StateStoreService`.
  `class`
  `MembershipStats`
  Data schema for storing NN stats in the `StateStoreService`.
  `class`
  `MountTable`
  Data schema for `MountTableStore` data stored in the `StateStoreService`.
  `class`
  `RouterState`
  Entry to log the state of a `Router` in the `StateStoreService`.
  `class`
  `StateStoreVersion`
  Entry to track the version of the State Store data stored in the State Store by a Router.
  Methods in org.apache.hadoop.hdfs.server.federation.store.records with parameters of type BaseRecord
  Modifier and Type
  Method
  Description
  `int`
  BaseRecord.`compareTo(BaseRecord record)`
  `int`
  MembershipState.`compareTo(BaseRecord record)`
  First use the comparator of the BaseRecord to compare the date modified.
  `int`
  RouterState.`compareTo(BaseRecord other)`
  `boolean`
  BaseRecord.`like(BaseRecord other)`
  Check if this record matches a partial record.
  `boolean`
  MembershipState.`like(BaseRecord o)`
  `boolean`
  MountTable.`like(BaseRecord o)`
  `boolean`
  RouterState.`like(BaseRecord o)`

- ## Uses of BaseRecord in org.apache.hadoop.hdfs.server.federation.store.records.impl.pb

  Subclasses of BaseRecord in org.apache.hadoop.hdfs.server.federation.store.records.impl.pb
  Modifier and Type
  Class
  Description
  `class`
  `DisabledNameservicePBImpl`
  Protobuf implementation of the `DisabledNameservice` record.
  `class`
  `MembershipStatePBImpl`
  Protobuf implementation of the MembershipState record.
  `class`
  `MembershipStatsPBImpl`
  Protobuf implementation of the MembershipStats record.
  `class`
  `MountTablePBImpl`
  Protobuf implementation of the MountTable record.
  `class`
  `RouterStatePBImpl`
  Protobuf implementation of the RouterState record.
  `class`
  `StateStoreVersionPBImpl`
  Protobuf implementation of the StateStoreVersion record.