Interface EnvironmentActionResponse

All Known Implementing Classes:
EnvironmentActionResponseJson
public interface EnvironmentActionResponse
The Fabric v4 EnvironmentActionResponse schema: the 201 body of POST /fabric/v4/serviceProfiles/{serviceProfileId}/environments/{environmentId}/actions.

Beta: the schema carries the catalog's Beta marker (catalog fetched 2026-09-21). The catalog publishes the schema but no response example, so which properties the service populates is unverified. Every getter can return null.

Properties
GetterCatalog propertyCatalog description
getHref()href (uri, read-only)"Environment action URI"
getType()typeEnvironmentActionTypeEnum
getUuid()uuid (uuid)"Equinix-assigned action identifier"
getState()state"ACTIVE - already used , INACTIVE - not used"
getKeyDetails()keyDetailsActivationKeyDetails
getChangeLog()changeLogChangelog

  • Method Details

    • getHref

      String getHref()

    • getType

      EnvironmentActionType getType()

    • getUuid

      String getUuid()

    • getState

      EnvironmentActionState getState()
      Usage state of the activation key. INACTIVE means not used; ACTIVE means already used.
      Returns:
      the state, UNKNOWN for a value this SDK release does not define, or null if the response omits it

    • getKeyDetails

      ActivationKeyDetails getKeyDetails()

    • getChangeLog

      ChangeLog getChangeLog()

    • isKeyUnused

      default boolean isKeyUnused()
      Reports whether the response states that the activation key has not been used. Derived from getState(); it is not a catalog property and is excluded from serialization.
      Returns:
      true only when getState() is INACTIVE; false for ACTIVE, UNKNOWN and null