Interface InternetAccessServices

All Known Implementing Classes:
InternetAccessServicesImpl
public interface InternetAccessServices
Client interface for the Equinix Internet Access (EIA) v2 service lifecycle.

Supports creating a service via the define() builder (POST /internetAccess/v2/services), retrieving it by id (GET /internetAccess/v2/services/{serviceId}), updating its mutable properties (PATCH /internetAccess/v2/services/{serviceId}), deleting it (DELETE /internetAccess/v2/services/{serviceId}) and searching across services (POST /internetAccess/v2/services/search).

  • Method Details

    • define

      InternetAccessServiceOperator.InternetAccessServiceBuilder define()
      Returns a builder for defining and creating a new Equinix Internet Access v2 service.
      Returns:
      an internet access service builder

    • getByUuid

      InternetAccessService getByUuid(String serviceId)
      Retrieves a single Equinix Internet Access v2 service by its unique identifier.
      Parameters:
      serviceId - the unique identifier of the service
      Returns:
      the service matching the given identifier

    • update

      InternetAccessService update(String serviceId, List<ChangeOperationUpdate> operations)
      Updates the mutable properties of an Equinix Internet Access v2 service by applying the supplied change operations (for example replacing /bandwidth).
      Parameters:
      serviceId - the unique identifier of the service to update
      operations - the change operations to apply
      Returns:
      the updated service

    • update

      InternetAccessService update(String serviceId, List<ChangeOperationUpdate> operations, boolean dryRun)
      Updates the mutable properties of an Equinix Internet Access v2 service, optionally in validate-only mode.

      Per the updateEquinixInternetAccess spec, dryRun is an optional boolean query parameter with no default: "Setting this parameter to true will perform only request validation without actually updating the service". When dryRun is false the parameter is omitted from the request entirely.

      Parameters:
      serviceId - the unique identifier of the service to update
      operations - the change operations to apply
      dryRun - if true, sends dryRun=true so the request is only validated and the service is not updated; if false, the parameter is omitted
      Returns:
      the updated (or, in dry-run mode, the validated) service

    • delete

      Boolean delete(String serviceId)
      Deletes an Equinix Internet Access v2 service by its unique identifier.
      Parameters:
      serviceId - the unique identifier of the service to delete
      Returns:
      true if the deletion request was accepted

    • delete

      Boolean delete(String serviceId, boolean dryRun)
      Deletes an Equinix Internet Access v2 service, optionally in validate-only mode.

      Per the deleteEquinixInternetAccess spec, dryRun is an optional boolean query parameter with no default: "Setting this parameter to true will perform only request validation without actually deleting the service". When dryRun is false the parameter is omitted from the request entirely. The 202 response carries no body.

      Parameters:
      serviceId - the unique identifier of the service to delete
      dryRun - if true, sends dryRun=true so the request is only validated and the service is not deleted; if false, the parameter is omitted
      Returns:
      true if the (deletion or validation) request was accepted

    • search

      PaginatedFilteredList<InternetAccessService> search(ServiceSearchRequest searchRequest)
      Searches for Equinix Internet Access v2 services matching the specified filter criteria.
      Parameters:
      searchRequest - the search filter criteria
      Returns:
      a paginated, filtered list of matching services