## Uses of Class
org.apache.hadoop.yarn.server.federation.store.records.SubClusterInfo

- Packages that use SubClusterInfo
  Package | Description
  --- | ---
  org.apache.hadoop.yarn.server.federation.policies | Federation Policies.
  org.apache.hadoop.yarn.server.federation.store.records | Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
  org.apache.hadoop.yarn.server.federation.store.records.impl.pb | Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
  org.apache.hadoop.yarn.server.federation.store.utils | Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
  org.apache.hadoop.yarn.server.federation.utils | Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.

- - ### Uses of SubClusterInfo in org.apache.hadoop.yarn.server.federation.policies

    Methods in org.apache.hadoop.yarn.server.federation.policies that return types with arguments of type SubClusterInfo
    Modifier and Type | Method and Description
    --- | ---
    `protected Map<SubClusterId,SubClusterInfo>` | AbstractConfigurableFederationPolicy.`getActiveSubclusters()` This methods gets active subclusters map from the `FederationStateStoreFacade` and validate it not being null/empty.

  - ### Uses of SubClusterInfo in org.apache.hadoop.yarn.server.federation.store.records

    Methods in org.apache.hadoop.yarn.server.federation.store.records that return SubClusterInfo
    Modifier and Type | Method and Description
    --- | ---
    `abstract SubClusterInfo` | SubClusterRegisterRequest.`getSubClusterInfo()` Get the `SubClusterInfo` encapsulating the information about the sub-cluster.
    `abstract SubClusterInfo` | GetSubClusterInfoResponse.`getSubClusterInfo()` Get the `SubClusterInfo` encapsulating the information about the sub-cluster.
    `static SubClusterInfo` | SubClusterInfo.`newInstance(SubClusterId subClusterId, String amRMServiceAddress, String clientRMServiceAddress, String rmAdminServiceAddress, String rmWebServiceAddress, long lastHeartBeat, SubClusterState state, long lastStartTime, String capability)`
    `static SubClusterInfo` | SubClusterInfo.`newInstance(SubClusterId subClusterId, String amRMServiceAddress, String clientRMServiceAddress, String rmAdminServiceAddress, String rmWebServiceAddress, SubClusterState state, long lastStartTime, String capability)`

    Methods in org.apache.hadoop.yarn.server.federation.store.records that return types with arguments of type SubClusterInfo
    Modifier and Type | Method and Description
    --- | ---
    `abstract List<SubClusterInfo>` | GetSubClustersInfoResponse.`getSubClusters()` Get the list of `SubClusterInfo` representing the information about all sub-clusters that are currently participating in Federation.

    Methods in org.apache.hadoop.yarn.server.federation.store.records with parameters of type SubClusterInfo
    Modifier and Type | Method and Description
    --- | ---
    `static SubClusterRegisterRequest` | SubClusterRegisterRequest.`newInstance(SubClusterInfo subClusterInfo)`
    `static GetSubClusterInfoResponse` | GetSubClusterInfoResponse.`newInstance(SubClusterInfo subClusterInfo)`
    `abstract void` | SubClusterRegisterRequest.`setSubClusterInfo(SubClusterInfo subClusterInfo)` Set the `SubClusterInfo` encapsulating the information about the sub-cluster.
    `abstract void` | GetSubClusterInfoResponse.`setSubClusterInfo(SubClusterInfo subClusterInfo)` Set the `SubClusterInfo` encapsulating the information about the sub-cluster.

    Method parameters in org.apache.hadoop.yarn.server.federation.store.records with type arguments of type SubClusterInfo
    Modifier and Type | Method and Description
    --- | ---
    `static GetSubClustersInfoResponse` | GetSubClustersInfoResponse.`newInstance(List<SubClusterInfo> subClusters)`
    `abstract void` | GetSubClustersInfoResponse.`setSubClusters(List<SubClusterInfo> subClusters)` Set the list of `SubClusterInfo` representing the information about all sub-clusters that are currently participating in Federation.

  - ### Uses of SubClusterInfo in org.apache.hadoop.yarn.server.federation.store.records.impl.pb

    Subclasses of SubClusterInfo in org.apache.hadoop.yarn.server.federation.store.records.impl.pb
    Modifier and Type | Class and Description
    --- | ---
    `class` | `SubClusterInfoPBImpl` Protocol buffer based implementation of `SubClusterInfo`.

    Methods in org.apache.hadoop.yarn.server.federation.store.records.impl.pb that return SubClusterInfo
    Modifier and Type | Method and Description
    --- | ---
    `SubClusterInfo` | SubClusterRegisterRequestPBImpl.`getSubClusterInfo()`
    `SubClusterInfo` | GetSubClusterInfoResponsePBImpl.`getSubClusterInfo()`

    Methods in org.apache.hadoop.yarn.server.federation.store.records.impl.pb that return types with arguments of type SubClusterInfo
    Modifier and Type | Method and Description
    --- | ---
    `List<SubClusterInfo>` | GetSubClustersInfoResponsePBImpl.`getSubClusters()`

    Methods in org.apache.hadoop.yarn.server.federation.store.records.impl.pb with parameters of type SubClusterInfo
    Modifier and Type | Method and Description
    --- | ---
    `void` | SubClusterRegisterRequestPBImpl.`setSubClusterInfo(SubClusterInfo subClusterInfo)`
    `void` | GetSubClusterInfoResponsePBImpl.`setSubClusterInfo(SubClusterInfo subClusterInfo)`

    Method parameters in org.apache.hadoop.yarn.server.federation.store.records.impl.pb with type arguments of type SubClusterInfo
    Modifier and Type | Method and Description
    --- | ---
    `void` | GetSubClustersInfoResponsePBImpl.`setSubClusters(List<SubClusterInfo> subClusters)`

  - ### Uses of SubClusterInfo in org.apache.hadoop.yarn.server.federation.store.utils

    Methods in org.apache.hadoop.yarn.server.federation.store.utils with parameters of type SubClusterInfo
    Modifier and Type | Method and Description
    --- | ---
    `static void` | FederationMembershipStateStoreInputValidator.`checkSubClusterInfo(SubClusterInfo subClusterInfo)` Validate if all the required fields on `SubClusterInfo` are present or not.

  - ### Uses of SubClusterInfo in org.apache.hadoop.yarn.server.federation.utils

    Methods in org.apache.hadoop.yarn.server.federation.utils that return SubClusterInfo
    Modifier and Type | Method and Description
    --- | ---
    `SubClusterInfo` | FederationStateStoreFacade.`getSubCluster(SubClusterId subClusterId)` Returns the `SubClusterInfo` for the specified `SubClusterId`.
    `SubClusterInfo` | FederationStateStoreFacade.`getSubCluster(SubClusterId subClusterId, boolean flushCache)` Updates the cache with the central `FederationStateStore` and returns the `SubClusterInfo` for the specified `SubClusterId`.

    Methods in org.apache.hadoop.yarn.server.federation.utils that return types with arguments of type SubClusterInfo
    Modifier and Type | Method and Description
    --- | ---
    `Map<SubClusterId,SubClusterInfo>` | FederationStateStoreFacade.`getSubClusters(boolean filterInactiveSubClusters)` Returns the `SubClusterInfo` of all active sub cluster(s).

Copyright © 2008–2022 Apache Software Foundation. All rights reserved.