Endpoint
in package
An endpoint serves as a location which receives and emits API interactions. It will therefore also host particular API resources. Each endpoint object has different access methods - one receives network connections over the public Internet, another receives traffic through an internal network. You will be able to access the latter from a Server, for example, in the same Region - which will incur no bandwidth charges, and be quicker.
Table of Contents
- $privateUrl : Url
- $publicUrl : Url
- $region : string
- factory() : Endpoint
- getPrivateUrl() : Url
- getPublicUrl() : Url
- getRegion() : string
- setPrivateUrl() : $this
- setPublicUrl() : $this
- setRegion() : $this
- getVersionedUrl() : mixed
- Returns the endpoint URL with a version in it
Properties
$privateUrl
private
Url
$privateUrl
$publicUrl
private
Url
$publicUrl
$region
private
string
$region
Methods
factory()
public
static factory( $object, string $supportedServiceVersion, OpenStack $client) : Endpoint
Parameters
- $object :
- $supportedServiceVersion : string
-
Service version supported by the SDK
- $client : OpenStack
-
OpenStack client
Return values
Endpoint —getPrivateUrl()
public
getPrivateUrl() : Url
Return values
Url —getPublicUrl()
public
getPublicUrl() : Url
Return values
Url —getRegion()
public
getRegion() : string
Return values
string —setPrivateUrl()
public
setPrivateUrl( $privateUrl) : $this
Parameters
Return values
$this —setPublicUrl()
public
setPublicUrl( $publicUrl) : $this
Parameters
Return values
$this —setRegion()
public
setRegion( $region) : $this
Parameters
Return values
$this —getVersionedUrl()
Returns the endpoint URL with a version in it
private
getVersionedUrl(string $url, string $supportedServiceVersion, OpenStack $client) : mixed
Parameters
- $url : string
-
Endpoint URL
- $supportedServiceVersion : string
-
Service version supported by the SDK
- $client : OpenStack
-
OpenStack client