Class ActivationKey.V1

java.lang.Object

com.eqixiac.equinix.core.model.multicloud.ActivationKey.V1

All Implemented Interfaces:

ActivationKey

Enclosing interface:

ActivationKey

public static final class ActivationKey.V1
extends Object
implements ActivationKey

A version 1 key: all members in cleartext.

Equality compares the five members, not the encoded form: two keys with the same members issued with different JSON member order are equal.

Author:

ianjones

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ActivationKey.V1.Builder	Builder for a version 1 key.

Nested classes/interfaces inherited from interface ActivationKey

ActivationKey.Opaque, ActivationKey.RedactingSerializer, ActivationKey.V1, ActivationKey.V2Encrypted

Modifier and Type	Interface	Description
static final class	ActivationKey.Opaque	A key this SDK release cannot interpret.
static final class	ActivationKey.RedactingSerializer	The Jackson serializer of every variant: it writes the empty object {} and nothing else, so no key material reaches JSON produced by any ObjectMapper, including one with SerializationFeature.FAIL_ON_EMPTY_BEANS enabled (the default).
static final class	ActivationKey.V1	A version 1 key: all members in cleartext.
static final class	ActivationKey.V2Encrypted	A version 2 key: the envelope in cleartext, everything else encrypted for the destination environment.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VERSION	The version value of this variant.

Method Summary

Modifier and Type	Method	Description
static ActivationKey.V1.Builder	builder()
int	connectionSizeMbps()
String	destinationAccountId()
String	destinationEnvironmentUri()
String	encode()
Optional<String>	envelopeDestinationEnvironmentUri()
OptionalInt	envelopeVersion()
boolean	equals(Object o)
int	hashCode()
String	sharedConnectionUuid()
String	toString()
int	version()

Methods inherited from class Object

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

Methods inherited from interface ActivationKey

destinationEnvironmentId

Modifier and Type	Method	Description
default Optional<String>	destinationEnvironmentId()	The environment id named by the envelope's destinationEnvironmentUri, extracted by EnvironmentRef.environmentIdOf(String).

Field Details

VERSION

public static final int VERSION

The version value of this variant.

See Also:

• Constant Field Values

Method Details

builder

public static ActivationKey.V1.Builder builder()

Returns:

a builder for a version 1 key in canonical encoding

version

public int version()

Returns:

1

destinationEnvironmentUri

public String destinationEnvironmentUri()

Returns:

the URI of the environment the key is intended for; never blank

sharedConnectionUuid

public String sharedConnectionUuid()

Returns:

the UUID both providers use for the connection; never blank. Sensitive.

connectionSizeMbps

public int connectionSizeMbps()

Returns:

the size of the connection to provision, in Mbps; always > 0

destinationAccountId

public String destinationAccountId()

Returns:

the customer's account id at the destination provider; never blank. Sensitive.

encode

public String encode()

Specified by:

encode in interface ActivationKey

Returns:

the string to hand to the receiving provider; see the class documentation for what each variant returns

envelopeVersion

public OptionalInt envelopeVersion()

Specified by:

envelopeVersion in interface ActivationKey

Returns:

the envelope's version; empty only for an ActivationKey.Opaque key whose payload carried no readable integer version

envelopeDestinationEnvironmentUri

public Optional<String> envelopeDestinationEnvironmentUri()

Specified by:

envelopeDestinationEnvironmentUri in interface ActivationKey

Returns:

the envelope's destinationEnvironmentUri; empty only for an ActivationKey.Opaque key whose payload carried no readable destinationEnvironmentUri

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

Returns:

a description that omits sharedConnectionUuid, destinationAccountId and the encoded form