Interface ServiceTokens

All Known Implementing Classes:
ServiceTokensImpl
public interface ServiceTokens
Client interface for managing Equinix Fabric service tokens. Service tokens allow third parties to create connections to your assets without requiring direct account access.
Author:
ianjones

  • Method Details

    • list

      PaginatedList<ServiceToken> list()
      Lists all service tokens accessible to the current account.
      Returns:
      a paginated list of service tokens

    • getByUuid

      ServiceToken getByUuid(String uuid)
      Retrieves a single service token by its unique identifier.
      Parameters:
      uuid - the unique identifier of the service token
      Returns:
      the service token matching the given UUID

    • define

      ServiceTokenOperator.ServiceTokenBuilder define(Side issuerSide)
      Begins the fluent builder for creating a new service token. Call methods on the returned builder to configure the token, then call create().
      Parameters:
      issuerSide - the side (A-side or Z-side) the token's access point is placed on
      Returns:
      a builder for configuring the new service token

    • search

      PaginatedFilteredList<ServiceToken> search()
      Searches for service tokens using default filter and sort criteria.
      Returns:
      a paginated, filtered list of matching service tokens

    • search

      PaginatedFilteredList<ServiceToken> search(FilterPropertyList filter)
      Searches for service tokens matching the specified filter criteria.
      Parameters:
      filter - the filter criteria to apply
      Returns:
      a paginated, filtered list of matching service tokens

    • search

      PaginatedFilteredList<ServiceToken> search(SortPropertyList sort)
      Searches for service tokens with the specified sort order.
      Parameters:
      sort - the sort criteria to apply
      Returns:
      a paginated, filtered list of matching service tokens

    • search

      PaginatedFilteredList<ServiceToken> search(FilterPropertyList filter, SortPropertyList sort)
      Searches for service tokens matching the specified filter and sort criteria.
      Parameters:
      filter - the filter criteria to apply
      sort - the sort criteria to apply
      Returns:
      a paginated, filtered list of matching service tokens

    • update

      ServiceTokenOperator.ServiceTokenUpdater update(String uuid)
      Begins a fluent PATCH update of an existing service token, e.g. serviceTokens.update(uuid).name("New-Name").save().
      Parameters:
      uuid - the unique identifier of the service token to update
      Returns:
      a fluent updater

    • createAction

      ServiceToken createAction(String uuid, ServiceTokenAction type)
      Issues an action against a service token (for example resending the email notification).
      Parameters:
      uuid - the unique identifier of the service token
      type - the action type
      Returns:
      the service token after the action