package hrn
- Alphabetic
- Public
- All
Type Members
-
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.
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