Packages

final case class HRN(partition: String, service: String, region: String, account: String, resource: String) extends Serializable with Product

An HRN (HERE Resource Name) is a resource descriptor that provides a globally unique handle for a resource. The HRN is generated by the HERE platform when the resource is created. Its structure can vary, so you should not try to parse HRNs or infer any meaning from them. Once a resource is created you cannot change the resource's HRN.

The string presentation of an HRN consists of the prefix "hrn:" followed by 5 colon (":") delimited fields: hrn:{partition}:{service}:{region}:{account}:{resource}

The resource field must be non-empty, but the other fields can be empty if they aren't relevant to the resource being identified.

For example, HERE Map Content catalog has the following HRN: "hrn:here:data::olp-here:rib-2".

In this case:

  • partition - here
  • service - data
  • region - (empty)
  • account - olp-here
  • resource - rib-2
partition

the federated environment in which the resource resides

service

the well-known service name to request this resource from

region

the region of the partition the service resides in if it is not global

account

the customer/account this resource is associated with

resource

a string identifier that uniquely identifies the resource in question

Linear Supertypes
Product, Equals, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HRN
  2. Product
  3. Equals
  4. Serializable
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HRN(partition: String, service: String, region: String, account: String, resource: String)

    partition

    the federated environment in which the resource resides

    service

    the well-known service name to request this resource from

    region

    the region of the partition the service resides in if it is not global

    account

    the customer/account this resource is associated with

    resource

    a string identifier that uniquely identifies the resource in question

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val account: String
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. val partition: String
  15. val region: String
  16. val resource: String
  17. val service: String
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. lazy val toString: String
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Product

Inherited from Equals

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped