Package api.equinix.javasdk.fabric.client

Interface ServiceProfiles

All Known Implementing Classes:

ServiceProfilesImpl

public interface ServiceProfiles

Client interface for managing Equinix Fabric service profiles. Service profiles define the attributes and access configurations that providers publish for customers to connect to.

Method Summary

Modifier and Type	Method	Description
ServiceProfileOperator.ServiceProfileBuilder	define(ServiceProfileType serviceProfileType)	Begins the fluent builder for creating a new service profile.
ServiceProfile	getByUuid(String uuid)	Retrieves a single service profile by its unique identifier.
PaginatedList<ServiceProfile>	list()	Lists all service profiles owned by the current account.
PaginatedFilteredList<ServiceProfile>	search()	Searches for service profiles using default filter and sort criteria.
PaginatedFilteredList<ServiceProfile>	search(FilterPropertyList filter)	Searches for service profiles matching the specified filter criteria.
PaginatedFilteredList<ServiceProfile>	search(FilterPropertyList filter, SortPropertyList sort)	Searches for service profiles matching the specified filter and sort criteria.
PaginatedFilteredList<ServiceProfile>	search(SortPropertyList sort)	Searches for service profiles with the specified sort order.

Method Details

list

PaginatedList<ServiceProfile> list()

Lists all service profiles owned by the current account.

Returns:

a paginated list of service profiles

search

PaginatedFilteredList<ServiceProfile> search()

Searches for service profiles using default filter and sort criteria.

Returns:

a paginated, filtered list of matching service profiles

search

PaginatedFilteredList<ServiceProfile> search(FilterPropertyList filter)

Searches for service profiles matching the specified filter criteria.

Parameters:

filter - the filter criteria to apply

Returns:

a paginated, filtered list of matching service profiles

search

PaginatedFilteredList<ServiceProfile> search(SortPropertyList sort)

Searches for service profiles with the specified sort order.

Parameters:

sort - the sort criteria to apply

Returns:

a paginated, filtered list of matching service profiles

search

PaginatedFilteredList<ServiceProfile> search(FilterPropertyList filter,
 SortPropertyList sort)

Searches for service profiles 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 profiles

getByUuid

ServiceProfile getByUuid(String uuid)

Retrieves a single service profile by its unique identifier.

Parameters:

uuid - the unique identifier of the service profile

Returns:

the service profile matching the given UUID

define

ServiceProfileOperator.ServiceProfileBuilder define(ServiceProfileType serviceProfileType)

Begins the fluent builder for creating a new service profile. Call methods on the returned builder to configure the profile, then call create().

Parameters:

serviceProfileType - the type of service profile to create

Returns:

a builder for configuring the new service profile