1. class
  2. OpenStack
  3. Identity
  4. v2
  5. Models
  6. Endpoint

Endpoint

class Endpoint extends OperatorResource

Represents an Identity v2 catalog entry endpoint.

Traits

OpenStack\Common\HydratorStrategyTrait
Represents common functionality for populating, or "hydrating", an object with arbitrary data.
OpenStack\Common\Api\OperatorTrait

Properties

$adminUrl string
$region string
$internalUrl string
$publicUrl string

Methods

supportsRegion (string $region) : bool

Indicates whether a given region is supported

supportsUrlType (string $urlType) : bool

Indicates whether a given URL type is supported

getUrl (string $urlType) : bool|string

Retrieves a URL for the endpoint based on a specific type.

Details

View source
supportsRegion(string $region)

Indicates whether a given region is supported

Parameters

$region string

Return value

bool

Example code

$bool = $endpoint->supportsRegion($region);

View source
supportsUrlType(string $urlType)

Indicates whether a given URL type is supported

Parameters

$urlType string

Return value

bool

Example code

$bool = $endpoint->supportsUrlType($urlType);

View source
getUrl(string $urlType)

Retrieves a URL for the endpoint based on a specific type.

Parameters

$urlType string Either "internalURL", "publicURL" or "adminURL" (case insensitive)

Return value

bool|string

Example code

$response = $endpoint->getUrl($urlType);