Uses of Interface
com.eqixiac.equinix.core.model.APIParam

Packages that use APIParam

Package	Description
com.eqixiac.equinix.core.enums	Shared enumerations used across multiple domains within the Equinix Java SDK.
com.eqixiac.equinix.core.http	HTTP communication layer for the Equinix Java SDK.
com.eqixiac.equinix.core.model	Core model interfaces and base types for the Equinix Java SDK.
com.eqixiac.equinix.core.util
com.eqixiac.equinix.customerportal.enums	Customer Portal enumerations for the Equinix Java SDK.
com.eqixiac.equinix.fabric.enums	Fabric-specific enumerations for the Equinix Java SDK.
com.eqixiac.equinix.iam.enums	Typed enumerations for the Equinix IAM (access v1) API.
com.eqixiac.equinix.ibxsmartview.enums	IBX SmartView enumerations for the Equinix Java SDK.
com.eqixiac.equinix.internetaccess.enums
com.eqixiac.equinix.networkedge.enums	Network Edge enumerations for the Equinix Java SDK.
com.eqixiac.equinix.networkedge.model.implementation
com.eqixiac.equinix.sts.enums	Typed enumerations for the Equinix Security Token Service (STS v1) API.

Uses of APIParam in com.eqixiac.equinix.core.enums

Classes in com.eqixiac.equinix.core.enums that implement APIParam

Modifier and Type	Class	Description
enum	BandwidthUnit
enum	MetroCode	Well-known Equinix metro codes.
enum	Region	The three Equinix geographic regions.

Uses of APIParam in com.eqixiac.equinix.core.http

Methods in com.eqixiac.equinix.core.http with parameters of type APIParam

Modifier and Type	Method	Description
static void	ParameterMapper.addAdditionalValue(Map<String, List<String>> queryParameters, String parameterName, APIParam parameterValue)
static List<String>	ParameterMapper.singleParamList(APIParam parameterValue)
static Map<String, List<String>>	ParameterMapper.singleParamMap(String parameterName, APIParam parameterValue)

Uses of APIParam in com.eqixiac.equinix.core.model

Classes in com.eqixiac.equinix.core.model that implement APIParam

Modifier and Type	Class	Description
class	Sortable

Uses of APIParam in com.eqixiac.equinix.core.util

Methods in com.eqixiac.equinix.core.util with parameters of type APIParam

Modifier and Type	Method	Description
static List<String>	ModelUtils.singleValueList(APIParam value)

Method parameters in com.eqixiac.equinix.core.util with type arguments of type APIParam

Modifier and Type	Method	Description
static List<String>	ModelUtils.stringListFromEnumList(List<APIParam> enumList)

Uses of APIParam in com.eqixiac.equinix.customerportal.enums

Classes in com.eqixiac.equinix.customerportal.enums that implement APIParam

Modifier and Type	Class	Description
enum	ActivityType
enum	AssetProductType	Product type used when filtering an asset search (filter.productTypes).
enum	AssetStatus	Lifecycle status of an installed-base asset.
enum	AttachmentPurpose	Purpose for which an attachment is uploaded (POST /v1/attachments/file, purpose query parameter).
enum	AttachmentSource	The source of a support case attachment (Attachment.source).
enum	BillingAccountStatus	Status of a billing account as returned by the Platform Billing Account v2 (BAS) API.
enum	BillingContactType
enum	BillingFrequency	Frequency at which a billing account is billed (Billing v1 finance accounts API).
enum	CabinetType	Type of a cabinet within a cage (Customer Portal Lookup v2 API).
enum	CageType	Type of a cage at an IBX location (Customer Portal Lookup v2 API).
enum	Channel	Channel used to place an order (Orders v2 / Billing v2 APIs).
enum	CircuitPhase	Phase of an AC power circuit for a secure cabinet.
enum	ConnectionService	The name of the available cross-connect connection service (Connection_services in the cross-connects v2 and lookup v2 specs).
enum	ConnectorType	Cross-connect connector type (connector_types in the cross-connects v2 and lookup v2 specs).
enum	ContactAvailability	Availability of a contact person (diLOA v1 + Orders v2 APIs).
enum	ContactDetailType	Means of contact for a Digital LOA contact detail (diLOA v1 API).
enum	ContactType
enum	ContractTerm	Contract term length for a secure cabinet order.
enum	CrossConnectMediaType	Cross-connect media type (media_types in the cross-connects v2 spec).
enum	DimensionUnit	Unit of measure for a cabinet dimension value.
enum	FabricPortSpeed	Fabric port speed available for a secure cabinet location.
enum	FileType	File type of a generated report (Reports v1 downloadable-report.fileType).
enum	Frequency
enum	InstallLocation	Location of an installed patch panel (Customer Portal Lookup v2 API).
enum	InvoiceDocumentFileType	File type of an invoice document (Billing v1 finance accounts API).
enum	InvoiceFormat	Format in which an account's invoices are produced (Billing v1 finance accounts API).
enum	InvoiceType	Type of an invoice document (Billing v1 finance accounts API).
enum	LoaChangeStatus	Status of a Digital LOA change record (diLOA v1 API).
enum	LoaChangeType	Type of a Digital LOA change record (diLOA v1 API).
enum	LoaContactType	Notification category relevant to a Digital LOA contact (diLOA v1 API).
enum	LoaLinkRel	Relationship of a HATEOAS link to its Digital LOA document (diLOA v1 API).
enum	LoaProductType	Type of a product covered by a Digital LOA (diLOA v1 API).
enum	LoaState	Status of a Digital LOA document (diLOA v1 API).
enum	NegotiationAction	Type of action to be carried out with an order negotiation.
enum	NotificationCategory	Category of a unified notification event (Customer Portal Unified Notifications v2 API).
enum	NotificationContactType	Type of a unified notification contact (Customer Portal Unified Notifications v2 API).
enum	NotificationProductType	Product type associated with a unified notification event (Customer Portal Unified Notifications v2 API).
enum	NotificationSortBy	Field name to sort a unified notifications search by (Customer Portal Unified Notifications v2 API).
enum	NotificationSortDirection	Sort direction for a unified notifications search (Customer Portal Unified Notifications v2 API).
enum	NotificationStatus	Status of a unified notification event (Customer Portal Unified Notifications v2 API; also covers the Notifications v1 notification-status values).
enum	NotificationType	Type of a unified notification event (Customer Portal Unified Notifications v2 API; also covers the Notifications v1 ibx-notification-type / network-notification-type values, which add IBX_SMARTVIEW).
enum	OrderStatus
enum	PartyType	Type of a Digital LOA party (diLOA v1 API).
enum	PatchPanelType	Type of a patch panel (Customer Portal Lookup v2 API).
enum	PaymentStatus	Status of a payment on a billing account (Billing v1 finance accounts API).
enum	PermissionCode
enum	PhonePreferenceToCall	Preferred time window to call a contact's phone number (workPhonePrefToCall / mobilePhonePrefToCall in smarthandsv1, shipmentsv1 and troubleticketv1).
enum	PlanFrequency	Billing frequency of a Smart Hands support plan.
enum	ProtocolType	Cross-connect protocol type (protocol_types in the cross-connects v2 spec).
enum	ProvisioningType	Provisioning type of a patch panel order (Customer Portal Lookup v2 API).
enum	PurchaseOrderType	Purchase order selection type (SmartHands orders + Orders v2 line-item purchase orders).
enum	QuoteStatus
enum	Region	Region of the Equinix legal entity that issued a billing document (Billing v2 API).
enum	SecureCabinetContactAvailability	Best time to call a secure cabinet technical contact (ContactAvailability schema of the Secure Cabinet v1 API).
enum	ShipmentCarrier	The carrier service delivering a shipment (carrier in the shipments v2 spec and carrierName in the shipments v1 spec).
enum	ShipmentTransportType	How a v1 shipment moves in or out of the IBX: via a carrier service or carried by the customer.
enum	SmartHandsCameraProvider	Who provides the camera for a smart hands pictures/document order (cameraProvidedBy in the smart hands v1 spec).
enum	SmartHandsConnectorType	Cable connector type for a smart hands run-jumper-cable or request-cables order (connectorType / connector in the smart hands v1 spec).
enum	SmartHandsContactType	Type of contact attached to a smart hands order.
enum	SmartHandsJumperType	Jumper type for a smart hands run-jumper-cable order (jumperType in the smart hands v1 spec).
enum	SmartHandsMediaType	Cable media type for a smart hands run-jumper-cable or request-cables order (mediaType in the smart hands v1 spec).
enum	SmartHandsScheduleType	Scheduling option for a smart hands order.
enum	SmartHandsVisitDuration	Duration of the visit for a smart hands cage-escort order (durationVisit in the smart hands v1 spec).
enum	SubChannel	Sub-channel used to place an order (Orders v2 / Billing v2 APIs - the union of both specs' values).
enum	SupportCaseStatus	The status of a support case / trouble ticket (support v2 API, StatusResponse).
enum	SupportPlanAssignmentStatus	Assignment status of a Smart Hands support plan assigned by a reseller to an end customer.
enum	SupportPlanStatus	Lifecycle status of a Smart Hands support plan.
enum	TermsOfUsePeriod	Period type of a terms-of-use entry on an invoice line item (Billing v2 API; the Quotes v2 termsOfUse_Details.period adds DAYS).
enum	TermsOfUseType	Type of a terms-of-use period on an invoice line item (Billing v2 API; the Quotes v2 termsOfUse_Details.type adds NON_RENEWAL_NOTICE).
enum	TicketCode	Trouble ticket problem code (Tickets_Create.code in the tickets v2 spec).
enum	TicketStatus	The current status of a trouble ticket (Tickets v2 API).
enum	TransactionType

Uses of APIParam in com.eqixiac.equinix.fabric.enums

Classes in com.eqixiac.equinix.fabric.enums that implement APIParam

Modifier and Type	Class	Description
enum	ChangeStatus	Current outcome of a change flow (the Fabric v4 Change.status / PortChange.status attribute).
enum	ChangeType	The kind of lifecycle change recorded against a Fabric resource (the change.type field).
enum	ConnectionState
enum	ConnectionStatus
enum	GatewayPackageCode
enum	MetroPresence
enum	NetworkEquinixStatus	Equinix-side provisioning status of a Fabric network (the operation.equinixStatus field).
enum	PortType	XF_PORT is the sole PortType value defined by the Fabric spec.
enum	ServiceProfileState
enum	SharedPortProduct
enum	SharedPortType

Uses of APIParam in com.eqixiac.equinix.iam.enums

Classes in com.eqixiac.equinix.iam.enums that implement APIParam

Modifier and Type	Class	Description
enum	ServiceAspect	One of the three API aspects of a service action (IAM access v1 spec schema ServiceAspect).

Uses of APIParam in com.eqixiac.equinix.ibxsmartview.enums

Classes in com.eqixiac.equinix.ibxsmartview.enums that implement APIParam

Modifier and Type	Class	Description
enum	AlertConfigurationState	Lifecycle state of a power alert configuration (spec schema AlertConfigurationReadModel, property state).
enum	AlertStatus	Status of a SmartView alert or power event (spec schemas AlertReadModel and PowerEventReadModel, property status).
enum	ChannelType	The delivery channel type for a streaming subscription.
enum	HierarchyLevelType	Level of a node in the SmartView location hierarchy (spec schema HierarchyNode, property levelType).
enum	PowerLevelType	Power-hierarchy level type used by the DCIM power APIs.
enum	SensorUnit	Unit of measure for a sensor reading.
enum	SubscriptionStatus	Lifecycle status of a streaming subscription.

Uses of APIParam in com.eqixiac.equinix.internetaccess.enums

Classes in com.eqixiac.equinix.internetaccess.enums that implement APIParam

Modifier and Type	Class	Description
enum	AccessPointType	A-side access point type of an Equinix Internet Access (EIA) v1 connection (spec schema AccessPointType): colocation (COLO) or virtual device (VD).
enum	AgreementType	The type of agreement associated with an Equinix Internet Access (EIA) account at an IBX, as returned by GET /internetAccess/v1/accounts/{accountNumber}/agreements.
enum	BgpAuthenticationType	BGP authentication type of an Equinix Internet Access (EIA) v2 routing protocol (spec schema BgpAuthenticationType).
enum	BillingType	Billing model of an Equinix Internet Access (EIA) v1 bandwidth configuration.
enum	ChangeType	Type of change applied to an Equinix Internet Access (EIA) v2 service (spec schema ChangeType).
enum	ConnectionType	Service connection type for Equinix Internet Access (EIA).
enum	ConnectivitySourceType	The connectivity source of an Equinix Internet Access (EIA) connection - where the connection originates from.
enum	ContactAvailability	Availability of a contact attached to an Equinix Internet Access (EIA) v2 service order.
enum	ContactDetailType	Type of a contact detail entry on an Equinix Internet Access (EIA) order contact (spec schema ContactItemDetails, property type).
enum	ContactType	Type of a contact attached to an Equinix Internet Access (EIA) v2 service order.
enum	CurrencyCode	ISO 4217 currency code of the billing account attached to an Equinix Internet Access (EIA) v1 account (GET /internetAccess/v1/accounts).
enum	CustomerAsnRange	Customer Autonomous System Number range used by a BGP routing protocol.
enum	ExportPolicy	Denotes which routes should be advertised to the internet for a BGP routing protocol.
enum	ImportPolicy	Customer-route import policy of an Equinix Internet Access (EIA) v1 routing configuration.
enum	IpBlockAnswer	Answer to a RIR justification question for a provider-assigned IP block (spec schema IpBlockQuestions, property answer).
enum	IpBlockQuestionType	RIR justification question asked for a provider-assigned IP block (spec schema IpBlockQuestions, property type).
enum	IpBlockType	Type discriminator of an Equinix Internet Access (EIA) IP block (spec schemas IpBlockType / IpBlockReadModel).
enum	OrderSignatory	Signatory of the order signature attached to an Equinix Internet Access (EIA) v2 service order.
enum	OrderState	Processing state of an Equinix Internet Access (EIA) v1 order.
enum	PatchPanelType	Type of patch panel in an Equinix Internet Access (EIA) v1 product-availability lookup (GET /internetAccess/v1/patchPanels).
enum	PortInterfaceType	Physical port interface type of an Equinix Internet Access (EIA) v1 dedicated port configuration (spec schema DedicatedPortDefaultConfiguration...physicalPort.interface, property type).
enum	PortOwnershipType	Ownership state of a patch-panel port in an Equinix Internet Access (EIA) v1 product-availability lookup (GET /internetAccess/v1/patchPanels).
enum	PortOwnerType	Type of entity that owns a patch-panel port in an Equinix Internet Access (EIA) v1 product-availability lookup (GET /internetAccess/v1/patchPanels).
enum	PriceCategory	Category of an Equinix Internet Access (EIA) v1 price entry.
enum	PriceChargeType	Charge type of an Equinix Internet Access (EIA) v1 price charge - whether the charge recurs monthly or is a one-off (non-recurring) charge.
enum	PriceChargeUnit	Billing unit of an Equinix Internet Access (EIA) v1 price charge: ITEM for fixed (per-item) billing, GB_1 per gigabyte, or MBPS_1 per megabit-per-second.
enum	ProductType	Product type of an Equinix Internet Access (EIA) v1 price entry.
enum	PurchaseOrderCategory	Service category a purchase order applies to, as used by the Equinix Internet Access (EIA) v1 purchase-order lookups.
enum	PurchaseOrderStatus	Lifecycle status of an Equinix Internet Access (EIA) v1 purchase order.
enum	PurchaseOrderType	Purchase order type for an Equinix Internet Access (EIA) v2 service order.
enum	PurposeOfIpBlock	Purpose of a provider-assigned (PA) IP block requested for an Equinix Internet Access (EIA) v2 service, supplied for regulatory reasons.
enum	Redundancy	Redundancy configuration of an Equinix Internet Access (EIA) v1 product configuration.
enum	Region	Geographic region of an Equinix IBX data center where Internet Access is available.
enum	RoutingProtocolType	Discriminator for the routing protocol nested in an EIA v2 service request.
enum	ServiceBilling	Billing type of an Equinix Internet Access (EIA) v2 service.
enum	ServiceOrderStatus	Status of the order backing an Equinix Internet Access (EIA) v2 service.
enum	ServiceOrderType	Type of the order backing an Equinix Internet Access (EIA) v2 service.
enum	ServiceState	Lifecycle state of an Equinix Internet Access (EIA) v2 service.
enum	ServiceTypeV2	Topology of an Equinix Internet Access (EIA) v2 service.
enum	SignatureType	The signature method permitted by an Equinix Internet Access (EIA) signature policy, as returned by GET /internetAccess/v1/signaturePolicies.
enum	TermsProduct	The Equinix product a set of terms and conditions applies to, as used by the Equinix Internet Access (EIA) v1 terms lookup (GET /internetAccess/v1/terms).
enum	TermsType	The category of terms and conditions returned by the Equinix Internet Access (EIA) v1 terms lookup (GET /internetAccess/v1/terms).
enum	UseCase	Intended use case of an Equinix Internet Access (EIA) v2 service.

Uses of APIParam in com.eqixiac.equinix.networkedge.enums

Classes in com.eqixiac.equinix.networkedge.enums that implement APIParam

Modifier and Type	Class	Description
enum	ACLInterfaceType	The interface an ACL template applies to when associating it with a virtual device, either the management (MGMT) or WAN (WAN) interface.
enum	BackupStatus
enum	BGPStatus
enum	Connectivity	Connectivity class.
enum	DeviceACLStatus	The provisioning status of an ACL template on a virtual device.
enum	DeviceCategory
enum	DeviceManagementType	Device management type (network-edgev1 wire values EQUINIX-CONFIGURED / SELF-CONFIGURED - hyphenated, unlike the constant names).
enum	DeviceStatus
enum	FileProcessType	Indicates whether an uploaded file is a license file (LICENSE) or a cloud-init / bootstrap file (CLOUD_INIT).
enum	LicenseType
enum	PackageCode
enum	VPNStatus	Status of a Network Edge VPN.

Uses of APIParam in com.eqixiac.equinix.networkedge.model.implementation

Classes in com.eqixiac.equinix.networkedge.model.implementation that implement APIParam

Modifier and Type	Class	Description
class	SoftwarePackage

Uses of APIParam in com.eqixiac.equinix.sts.enums

Classes in com.eqixiac.equinix.sts.enums that implement APIParam

Modifier and Type	Class	Description
enum	ProviderStatus	Trust status of an OIDC identity provider (STS v1 spec schema ProviderStatus): ENABLED means token exchange is enabled, SUSPENDED means token exchange for ID tokens from this provider is currently disabled.
enum	TokenType	OAuth 2.0 token type of an issued STS token (STS v1 spec schema TokenResponse, property tokenType).