Interface PrecisionTimes
- All Known Implementing Classes:
PrecisionTimesImpl
public interface PrecisionTimes
Client interface for managing Equinix Fabric Precision Time services. Precision Time provides
NTP and PTP time synchronization services for connected infrastructure.
-
Method Summary
Modifier and TypeMethodDescriptiondefine()Begins the fluent builder for creating a new precision time service.fulfill(String uuid, TimeServiceFulfillRequest request) Fulfills (provisions) an existing precision time service with a fullprecisionTimeServiceRequestbody, allowing the requiredtype,name,packageandipv4properties (and the optional NTP / PTP advanced configuration, project and order) to be supplied alongside the connections.Fulfills (provisions) an existing precision time service by attaching the given Fabric connections to it.Retrieves a single precision time service by its unique identifier.getConnections(String serviceId) Lists the L2 connections associated with a precision time service instance.list()Lists precision time services throughPOST /fabric/v4/timeServices/searchwith an empty filter.packageByCode(PrecisionTimePackageCode packageCode) Retrieves a single precision time service package by its package code.packages()Lists the available precision time service packages (NTP/PTP, standard/enterprise).search(FilterPropertyList filter, SortPropertyList sort) Searches precision time services (POST /fabric/v4/timeServices/search).
-
Method Details
-
list
PaginatedList<PrecisionTime> list()Lists precision time services throughPOST /fabric/v4/timeServices/searchwith an empty filter. The specification documents/project/projectIdas a mandatory filter property, so prefersearch(FilterPropertyList, SortPropertyList)with a project filter; the service may reject an unfiltered search.- Returns:
- a paginated list of precision time services
-
search
Searches precision time services (POST /fabric/v4/timeServices/search). Filter properties:/project/projectId(mandatory per the spec),/name,/uuid,/type,/state,/account/accountNumber,/package/code.- Parameters:
filter- the search filtersort- the sort criteria, may benull- Returns:
- the matching services, paged
-
getByUuid
Retrieves a single precision time service by its unique identifier.- Parameters:
uuid- the unique identifier of the precision time service- Returns:
- the precision time service matching the given UUID
-
define
Begins the fluent builder for creating a new precision time service. Call methods on the returned builder to configure the service, then callcreate().- Returns:
- a builder for configuring the new precision time service
-
packages
List<TimeServicePackage> packages()Lists the available precision time service packages (NTP/PTP, standard/enterprise).- Returns:
- the list of time service packages
-
packageByCode
Retrieves a single precision time service package by its package code.- Parameters:
packageCode- the package code- Returns:
- the time service package matching the given code
-
getConnections
Lists the L2 connections associated with a precision time service instance.- Parameters:
serviceId- the unique identifier of the precision time service- Returns:
- the list of connection links
-
fulfill
Fulfills (provisions) an existing precision time service by attaching the given Fabric connections to it.- Parameters:
uuid- the unique identifier of the precision time serviceconnectionUuids- the Fabric connection UUIDs to attach- Returns:
- the updated precision time service
-
fulfill
Fulfills (provisions) an existing precision time service with a fullprecisionTimeServiceRequestbody, allowing the requiredtype,name,packageandipv4properties (and the optional NTP / PTP advanced configuration, project and order) to be supplied alongside the connections.- Parameters:
uuid- the unique identifier of the precision time servicerequest- the fulfillment request body- Returns:
- the updated precision time service
-