Package clusterless.commons.naming

Class Ref

java.lang.Object

clusterless.commons.naming.Ref

public final class Ref
extends Object

Creates an identifier to use as an export/import key for provider output/export values.

 aws:qualifier:[stage:]scopeName:scopeVersion:resourceNS:resourceType:resourceName
 

Where the qualifier represents the type of value being exported/imported: - id - name - arn

Where stage is the stage of the deployment, such as dev, test, prod, etc. It is optional.

scopeName and scopeVersion are analogous to project names and versions.

Resources are identified by a namespace, type, and name.

   ref:aws:id:project-a:20230101:core:compute:spot
   ref:aws:id:dev:project-a:20230101:core:compute:spot
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Ref.Qualifier

Constructor Summary

Constructors

Constructor	Description
Ref()

Method Summary

Modifier and Type	Method	Description
static Ref	arnRef()
boolean	equals(Object o)
String	exportName()
int	hashCode()
static Ref	idRef()
static boolean	isRef(String value)
Label	label()
static Ref	nameRef()
Label	provider()
static String	provider(String value)
Ref.Qualifier	qualifier()
static Ref	ref()
Label	resourceLabel()
Fixed	resourceName()
Fixed	resourceNs()
Fixed	resourceType()
Fixed	scope()
Fixed	scopeVersion()
Stage	stage()
String	toString()
Ref	withProvider(Fixed provider)
Ref	withProvider(Label provider)
Ref	withProvider(String provider)
Ref	withQualifier(Ref.Qualifier qualifier)
Ref	withResourceName(Fixed resourceName)
Ref	withResourceName(Label resourceName)
Ref	withResourceName(String resourceName)
Ref	withResourceNs(Fixed resourceNs)
Ref	withResourceNs(Label resourceNs)
Ref	withResourceNs(String resourceNs)
Ref	withResourceType(Fixed resourceType)
Ref	withResourceType(Label resourceType)
Ref	withResourceType(String resourceType)
Ref	withScope(Fixed scope)
Ref	withScope(Label scope)
Ref	withScope(String scope)
Ref	withScopeVersion(Fixed scopeVersion)
Ref	withScopeVersion(Version scopeVersion)
Ref	withScopeVersion(String scopeVersion)
Ref	withStage(Stage stage)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Ref

public Ref()

Method Details

ref

public static Ref ref()

idRef

public static Ref idRef()

arnRef

public static Ref arnRef()

nameRef

public static Ref nameRef()

isRef

public static boolean isRef(String value)

provider

public static String provider(String value)

withProvider

public Ref withProvider(String provider)

withProvider

public Ref withProvider(Label provider)

withProvider

public Ref withProvider(Fixed provider)

withStage

public Ref withStage(Stage stage)

withScope

public Ref withScope(String scope)

withScope

public Ref withScope(Label scope)

withScope

public Ref withScope(Fixed scope)

withScopeVersion

public Ref withScopeVersion(String scopeVersion)

withScopeVersion

public Ref withScopeVersion(Fixed scopeVersion)

withScopeVersion

public Ref withScopeVersion(Version scopeVersion)

withResourceNs

public Ref withResourceNs(String resourceNs)

withResourceNs

public Ref withResourceNs(Label resourceNs)

withResourceNs

public Ref withResourceNs(Fixed resourceNs)

withResourceType

public Ref withResourceType(String resourceType)

withResourceType

public Ref withResourceType(Label resourceType)

withResourceType

public Ref withResourceType(Fixed resourceType)

withResourceName

public Ref withResourceName(String resourceName)

withResourceName

public Ref withResourceName(Label resourceName)

withResourceName

public Ref withResourceName(Fixed resourceName)

withQualifier

public Ref withQualifier(Ref.Qualifier qualifier)

provider

public Label provider()

stage

public Stage stage()

scope

public Fixed scope()

scopeVersion

public Fixed scopeVersion()

resourceNs

public Fixed resourceNs()

resourceType

public Fixed resourceType()

resourceName

public Fixed resourceName()

qualifier

public Ref.Qualifier qualifier()

resourceLabel

public Label resourceLabel()

label

public Label label()

exportName

public String exportName()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object