Overview

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CloudMonitoring
      • 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
      • Enum
      • Resource
    • ObjectStore
      • Constants
      • Exception
      • Resource
      • Upload
    • Orchestration
    • Queues
      • Exception
      • Resource
    • Volume
      • Resource
  • PHP

Classes

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

Interfaces

  • ServiceInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Download

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( mixed $object )

Construct a CatalogItem from a mixed input.

Construct a CatalogItem from a mixed input.

Parameters

$object
mixed
$object

Returns

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

Parameters

$name
mixed
$name

Returns

mixed
$this
public string
# getName( )

Returns

string
public boolean
# hasName( mixed $string )

A basic string check.

A basic string check.

Parameters

$string
mixed
$string

Returns

boolean
public mixed
# setType( mixed $type )

Parameters

$type
mixed
$type

Returns

mixed
$this
public string
# getType( )

Returns

string
public boolean
# hasType( mixed $string )

Parameters

$string
mixed
$string

Returns

boolean
public mixed
# setEndpoints( array $endpoints )

Parameters

$endpoints
array
$endpoints

Returns

mixed
$this
public array
# getEndpoints( )

Returns

array
public mixed
# getEndpointFromRegion( mixed $region )

Using a standard data object, extract its endpoint.

Using a standard data object, extract its endpoint.

Parameters

$region
mixed
$region

Returns

mixed

Throws

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