Interface CompanyProfiles

All Known Implementing Classes:
CompanyProfilesImpl
public interface CompanyProfiles
Client interface for managing Equinix Fabric company profiles and their service-profile / tag attachments.

  • Method Details

    • search

      PaginatedFilteredList<CompanyProfile> search()
      Searches for company profiles using default filter and sort criteria.
      Returns:
      a paginated, filtered list of matching company profiles

    • search

      PaginatedFilteredList<CompanyProfile> search(FilterPropertyList filter)
      Searches for company profiles matching the specified filter criteria.
      Parameters:
      filter - the filter criteria to apply
      Returns:
      a paginated, filtered list of matching company profiles

    • search

      PaginatedFilteredList<CompanyProfile> search(SortPropertyList sort)
      Searches for company profiles with the specified sort order.
      Parameters:
      sort - the sort criteria to apply
      Returns:
      a paginated, filtered list of matching company profiles

    • search

      PaginatedFilteredList<CompanyProfile> search(FilterPropertyList filter, SortPropertyList sort)
      Searches for company 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 company profiles

    • getByUuid

      CompanyProfile getByUuid(String uuid)
      Retrieves a single company profile by its unique identifier.
      Parameters:
      uuid - the unique identifier of the company profile
      Returns:
      the company profile matching the given UUID

    • define

      CompanyProfileOperator.CompanyProfileBuilder define(String type)
      Begins the fluent builder for creating a new company profile.
      Parameters:
      type - the company profile type (for example COMPANY_PROFILE)
      Returns:
      a builder for configuring the new company profile

    • attachServiceProfile

      Boolean attachServiceProfile(String companyProfileId, String serviceProfileId)
      Attaches a service profile to a company profile.
      Parameters:
      companyProfileId - the company profile uuid
      serviceProfileId - the service profile uuid
      Returns:
      true if the attach was accepted

    • detachServiceProfile

      Boolean detachServiceProfile(String companyProfileId, String serviceProfileId)
      Detaches a service profile from a company profile.
      Parameters:
      companyProfileId - the company profile uuid
      serviceProfileId - the service profile uuid
      Returns:
      true if the detach was accepted

    • attachTag

      Boolean attachTag(String companyProfileId, String tagId)
      Attaches a tag to a company profile.
      Parameters:
      companyProfileId - the company profile uuid
      tagId - the tag uuid
      Returns:
      true if the attach was accepted

    • detachTag

      Boolean detachTag(String companyProfileId, String tagId)
      Detaches a tag from a company profile.
      Parameters:
      companyProfileId - the company profile uuid
      tagId - the tag uuid
      Returns:
      true if the detach was accepted

    • getServiceProfiles

      List<CompanyServiceProfile> getServiceProfiles(String companyProfileId)
      Lists the service profiles attached to a company profile.
      Parameters:
      companyProfileId - the company profile uuid
      Returns:
      the attached service profiles (href / uuid references)

    • getTags

      List<Tag> getTags(String companyProfileId)
      Lists the tags attached to a company profile.
      Parameters:
      companyProfileId - the company profile uuid
      Returns:
      the attached tags

    • getPrivateServices

      List<PrivateService> getPrivateServices(String companyProfileId)
      Lists the private services attached to a company profile.
      Parameters:
      companyProfileId - the company profile uuid
      Returns:
      the attached private services (href / uuid references)

    • attachPrivateService

      Boolean attachPrivateService(String companyProfileId, String privateServiceId)
      Attaches a private service to a company profile.
      Parameters:
      companyProfileId - the company profile uuid
      privateServiceId - the private service uuid
      Returns:
      true if the attach was accepted

    • detachPrivateService

      Boolean detachPrivateService(String companyProfileId, String privateServiceId)
      Detaches a private service from a company profile.
      Parameters:
      companyProfileId - the company profile uuid
      privateServiceId - the private service uuid
      Returns:
      true if the detach was accepted

    • getLogo

      byte[] getLogo(String uuid)
      Downloads the raw bytes of a company profile logo.
      Parameters:
      uuid - the logo uuid
      Returns:
      the logo image content

    • deleteLogo

      Boolean deleteLogo(String uuid)
      Deletes a company profile logo.
      Parameters:
      uuid - the logo uuid
      Returns:
      true if the delete was accepted