Overview
  • Namespace
  • Class

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CDN
      • Resource
    • CloudMonitoring
      • Collection
      • Exception
      • Resource
    • Common
      • Collection
      • Constants
      • Exceptions
      • Http
        • Message
      • Log
      • Resource
      • Service
    • Compute
      • Constants
      • Exception
      • Resource
    • Database
      • Resource
    • DNS
      • Collection
      • Resource
    • Identity
      • Constants
      • Resource
    • Image
      • Enum
      • Resource
        • JsonPatch
        • Schema
    • LoadBalancer
      • Collection
      • Enum
      • Resource
    • Networking
      • Resource
    • ObjectStore
      • Constants
      • Enum
      • Exception
      • Resource
      • Upload
    • Orchestration
      • Resource
    • Queues
      • Collection
      • Exception
      • Resource
    • Volume
      • Resource

Classes

  • AbstractService
  • Catalog
  • CatalogItem
  • CatalogService
  • Endpoint
  • NovaService
  • ServiceBuilder

Interfaces

  • ServiceInterface

Class CatalogItem

This object represents an individual service catalog item - in other words an API Service. Each service has particular information which form the basis of how it distinguishes itself, and how it executes API operations.

Namespace: OpenCloud\Common\Service
Located at OpenCloud/Common/Service/CatalogItem.php

Methods summary

public static OpenCloud\Common\Service\CatalogItem
# factory( $object )

Construct a CatalogItem from a mixed input.

Construct a CatalogItem from a mixed input.

Parameters

$object

Returns

OpenCloud\Common\Service\CatalogItem
public
# setName( $name )

Parameters

$name

Returns


$this
public string
# getName( )

Returns

string
public boolean
# hasName( $string )

A basic string check.

A basic string check.

Parameters

$string

Returns

boolean
public
# setType( $type )

Parameters

$type

Returns


$this
public string
# getType( )

Returns

string
public boolean
# hasType( $string )

Parameters

$string

Returns

boolean
public
# setEndpoints( array $endpoints )

Parameters

$endpoints

Returns


$this
public array
# getEndpoints( )

Returns

array
public mixed
# getEndpointFromRegion( string $region, boolean $isRegionless = false )

Using a standard data object, extract its endpoint.

Using a standard data object, extract its endpoint.

Parameters

$region
$isRegionless

Returns

mixed

Throws

OpenCloud\Common\Exceptions\EndpointError
API documentation generated by ApiGen