Package fr.gouv.vitam.common.storage.cas.container.api

# Interface Location

public interface Location
Description of where a resource is running. Note this can be physical or virtual.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getDescription()`
  Description of the location
  `String`
  `getId()`
  Unique ID provided by the provider (us-standard, miami, etc)
  `Set<String>`
  `getIso3166Codes()`
  `Map<String,Object>`
  `getMetadata()`
  `Location`
  `getParent()`
  The parent, or null, if top-level
  `LocationScope`
  `getScope()`
  Scope of the location, ex.

- ## Method Details

  - ### getScope

    LocationScope getScope()
    Scope of the location, ex. region, zone, host

  - ### getId

    String getId()
    Unique ID provided by the provider (us-standard, miami, etc)

  - ### getDescription

    String getDescription()
    Description of the location

  - ### getParent

    Location getParent()
    The parent, or null, if top-level

  - ### getMetadata

    Map<String,Object> getMetadata()
    Returns:
      immutable set of metadata relating to this location

  - ### getIso3166Codes

    Set<String> getIso3166Codes()
    Returns:
      if known, the IS0 3166 or 3166-2 divisions where this service may run. ex. a set of strings like "US" or "US-CA"; otherwise returns an empty list.
    See Also:
      - 3166