Package api.equinix.javasdk.networkedge.client

Interface Setup

All Known Implementing Classes:

SetupImpl

public interface Setup

Client interface for Network Edge setup and configuration operations. Provides access to account listings, metro availability, DNS lookups, agreement management, vendor terms, order terms, and pricing information.

Version:

$Id: $Id

Author:

ianjones

Method Summary

Modifier and Type	Method	Description
AgreementStatus	createAgreement(String accountNumber, String termsVersionId)	Creates an Agreement for the provided account number.
Map<String,DNSLookup>	dnsLookup(RequestBuilder.DNSLookup requestBuilder)	Returns DNS Lookup information.
AgreementStatus	getAgreementStatus(String accountNumber)	Returns the Agreement Status for the provided account number.
byte[]	getOrderSummary(RequestBuilder.OrderSummary requestBuilder)	Gets the order summary document based on the parameters provided.
String	getOrderTerms()	Returns the order terms for Network Edge.
Pricing	getPricing(RequestBuilder.Pricing requestBuilder)	Gets pricing information based on the parameters provided.
Pricing	getPricing(String deviceUuid)	Gets pricing information for the specified Device.
String	getVendorsTerms(String vendorPackage, LicenseType licenseType)	Returns the vendor terms for the specified vendor package and license type.
List<Account>	listAccounts(MetroCode metroCode)	Lists available Accounts in the provided metro.
List<Account>	listAllAccounts()	Lists available Accounts in all available metros.
PaginatedList<Metro>	listMetros()	Lists available Metros with Network Edge present.
PaginatedList<Metro>	listMetrosByRegion(Region region)	Lists available Metros with Network Edge present in the specified Region.

Method Details

listAccounts

List<Account> listAccounts(MetroCode metroCode)

Lists available Accounts in the provided metro.

Parameters:

metroCode - the MetroCode of the accounts.

Returns:

List

listAllAccounts

List<Account> listAllAccounts()

Lists available Accounts in all available metros. Note that this can be a slow operation as it checks every metro and then de-dupes accounts based on accountId and then referenceId.

Returns:

List

listMetros

PaginatedList<Metro> listMetros()

Lists available Metros with Network Edge present.

Returns:

PaginatedList

listMetrosByRegion

PaginatedList<Metro> listMetrosByRegion(Region region)

Lists available Metros with Network Edge present in the specified Region.

Parameters:

region - the Region of the metros.

Returns:

PaginatedList

dnsLookup

Map<String,DNSLookup> dnsLookup(RequestBuilder.DNSLookup requestBuilder)

Returns DNS Lookup information.

Parameters:

requestBuilder - the desired query parameters.

Returns:

Map

getAgreementStatus

AgreementStatus getAgreementStatus(String accountNumber)

Returns the Agreement Status for the provided account number.

Parameters:

accountNumber - the unique account identifier.

Returns:

String

createAgreement

AgreementStatus createAgreement(String accountNumber,
 String termsVersionId)

Creates an Agreement for the provided account number. The termsVersionId can be obtained from getAgreementStatus().

Parameters:

accountNumber - the unique account identifier.

termsVersionId - the unique identifier of the agreement terms version.

Returns:

AgreementStatus

getVendorsTerms

String getVendorsTerms(String vendorPackage,
 LicenseType licenseType)

Returns the vendor terms for the specified vendor package and license type.

Parameters:

vendorPackage - the desired vendor package.

licenseType - the desired LicenseType.

Returns:

String

getOrderTerms

String getOrderTerms()

Returns the order terms for Network Edge.

Returns:

String

getPricing

Pricing getPricing(RequestBuilder.Pricing requestBuilder)

Gets pricing information based on the parameters provided.

Parameters:

requestBuilder - the desired query parameters.

Returns:

Pricing

getPricing

Pricing getPricing(String deviceUuid)

Gets pricing information for the specified Device.

Parameters:

deviceUuid - the unique identifier of the Device.

Returns:

Pricing

getOrderSummary

byte[] getOrderSummary(RequestBuilder.OrderSummary requestBuilder)

Gets the order summary document based on the parameters provided.

Parameters:

requestBuilder - the desired query parameters.

Returns:

the order summary as a byte array.