PHP Класс Scalr\Service\OpenStack\OpenStackConfig

С версии: 06.12.2012
Автор: Vitaliy Demidov ([email protected])
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
__construct ( string $username, string $identityEndpoint, string $region, string $apiKey = null, Closur\Closure $updateTokenCallback = null, Scalr\Service\OpenStack\Client\AuthToken $authToken = null, string $password = null, string $tenantName = null, string $domainName = null, string $identityVersion = null, array $proxySettings = null, integer $requestTimeout = null ) Convenient constructor
getApiKey ( ) : string Gets User's API Key
getAuthQueryString ( ) : array Gets auth query string
getAuthToken ( ) : Scalr\Service\OpenStack\Client\AuthToken Gets an Auth Token
getDomainName ( ) : string Gets OpenStack identity domain name
getIdentityEndpoint ( ) : string Gets OpenStack identity endpoint
getIdentityVersion ( ) : string Gets OpenStack API version
getPassword ( ) : string Gets user's password
getProjectId ( ) : string Gets OpenStack project id
getProjectName ( ) : string Gets OpenStack project id It same as tenant name for Identity v2
getProxySettings ( )
getRegion ( ) : string Gets region
getRequestTimeout ( ) : integer Gets request timeout for api calls
getTenantName ( ) : string Gets OpenStack tenant name
getUpdateTokenCallback ( ) : Closur\Closure Gets update token callback
getUserId ( ) : string Gets OpenStack user id
getUsername ( ) : string Gets an username
isOpenStack ( ) : boolean Checks whether this is OpenStack Endpoint
parseIdentityVersion ( string $keystone ) : integer | null Parses the version of identity endpoint url
resetRequestTimeout ( ) : OpenStackConfig Sets default request timeout for api calls (from config)
setApiKey ( string $apiKey ) : OpenStackConfig Sets API Key
setAuthToken ( Scalr\Service\OpenStack\Client\AuthToken $authToken = null ) : OpenStackConfig Sets an Auth Token
setDomainName ( string $domainName ) : OpenStackConfig Sets OpenStack identity domain name
setIdentityEndpoint ( string $identityEndpoint ) : OpenStackConfig Sets a OpenStack identity endpoint
setIdentityVersion ( integer $version = null ) Sets OpenStack API version
setPassword ( string $password ) : OpenStackConfig Sets user's password
setProjectId ( string $projectId ) Sets OpenStack project id
setProxySettings ( array $proxySettings = null )
setRegion ( string $region ) : OpenStackConfig Sets OpenStack Region
setRequestTimeout ( integer $requestTimeout ) : OpenStackConfig Sets request timeout for api calls
setTenantName ( string $tenantName ) : OpenStackConfig Sets OpenStack tenant name
setUpdateTokenCallback ( Closur\Closure $updateTokenCallback = null ) Sets update token callback
setUserId ( string $userId ) Sets OpenStack user id
setUsername ( string $username ) : OpenStackConfig Sets username

Описание методов

__construct() публичный Метод

Convenient constructor
public __construct ( string $username, string $identityEndpoint, string $region, string $apiKey = null, Closur\Closure $updateTokenCallback = null, Scalr\Service\OpenStack\Client\AuthToken $authToken = null, string $password = null, string $tenantName = null, string $domainName = null, string $identityVersion = null, array $proxySettings = null, integer $requestTimeout = null )
$username string An user name
$identityEndpoint string OpenStack Identity Endpoint
$region string OpenStack Region
$apiKey string optional An User's API Key
$updateTokenCallback Closur\Closure optional Update Token Callback This function must accept one parameter AuthToken object.
$authToken Scalr\Service\OpenStack\Client\AuthToken optional Authentication token for the OpenStack service.
$password string optional An User's password
$tenantName string optional Either tenant name for V2 or project for V3
$domainName string optional The domain name
$identityVersion string optional The version of the identity
$proxySettings array optional Proxy settings
$requestTimeout integer optional Request timeout

getApiKey() публичный Метод

Gets User's API Key
public getApiKey ( ) : string
Результат string $apiKey Returns user API key

getAuthQueryString() публичный Метод

Gets auth query string
public getAuthQueryString ( ) : array
Результат array Returns auth query

getAuthToken() публичный Метод

Gets an Auth Token
public getAuthToken ( ) : Scalr\Service\OpenStack\Client\AuthToken
Результат Scalr\Service\OpenStack\Client\AuthToken An authentication token.

getDomainName() публичный Метод

Gets OpenStack identity domain name
public getDomainName ( ) : string
Результат string Returns OpenStack identity domain name.

getIdentityEndpoint() публичный Метод

Gets OpenStack identity endpoint
public getIdentityEndpoint ( ) : string
Результат string Returns identity endpoint

getIdentityVersion() публичный Метод

Gets OpenStack API version
public getIdentityVersion ( ) : string
Результат string Returns the version of the identity

getPassword() публичный Метод

Gets user's password
public getPassword ( ) : string
Результат string Returns user's password

getProjectId() публичный Метод

Gets OpenStack project id
public getProjectId ( ) : string
Результат string

getProjectName() публичный Метод

Gets OpenStack project id It same as tenant name for Identity v2
public getProjectName ( ) : string
Результат string

getProxySettings() публичный Метод

public getProxySettings ( )

getRegion() публичный Метод

Gets region
public getRegion ( ) : string
Результат string Returns OpenStack Region

getRequestTimeout() публичный Метод

Gets request timeout for api calls
public getRequestTimeout ( ) : integer
Результат integer Returns request timeout

getTenantName() публичный Метод

Gets OpenStack tenant name
public getTenantName ( ) : string
Результат string Returns OpenStack tenant name.

getUpdateTokenCallback() публичный Метод

Gets update token callback
public getUpdateTokenCallback ( ) : Closur\Closure
Результат Closur\Closure Returns update token callback

getUserId() публичный Метод

Gets OpenStack user id
public getUserId ( ) : string
Результат string

getUsername() публичный Метод

Gets an username
public getUsername ( ) : string
Результат string Returns an username

isOpenStack() публичный Метод

Checks whether this is OpenStack Endpoint
public isOpenStack ( ) : boolean
Результат boolean Returns TRUE if it is OpenStack Endpoint

parseIdentityVersion() публичный статический Метод

Parses the version of identity endpoint url
public static parseIdentityVersion ( string $keystone ) : integer | null
$keystone string The identity endpoint url
Результат integer | null Returns the major version number or NULL if it cannot be obtained from the specified URL

resetRequestTimeout() публичный Метод

Sets default request timeout for api calls (from config)
public resetRequestTimeout ( ) : OpenStackConfig
Результат OpenStackConfig

setApiKey() публичный Метод

Sets API Key
public setApiKey ( string $apiKey ) : OpenStackConfig
$apiKey string An User API Key
Результат OpenStackConfig

setAuthToken() публичный Метод

Sets an Auth Token
public setAuthToken ( Scalr\Service\OpenStack\Client\AuthToken $authToken = null ) : OpenStackConfig
$authToken Scalr\Service\OpenStack\Client\AuthToken An authentication token.
Результат OpenStackConfig

setDomainName() публичный Метод

Sets OpenStack identity domain name
public setDomainName ( string $domainName ) : OpenStackConfig
$domainName string OpenStack identity domain name
Результат OpenStackConfig

setIdentityEndpoint() публичный Метод

Sets a OpenStack identity endpoint
public setIdentityEndpoint ( string $identityEndpoint ) : OpenStackConfig
$identityEndpoint string OpenStack identity endpoint
Результат OpenStackConfig

setIdentityVersion() публичный Метод

Sets OpenStack API version
public setIdentityVersion ( integer $version = null )
$version integer

setPassword() публичный Метод

Sets user's password
public setPassword ( string $password ) : OpenStackConfig
$password string An User password.
Результат OpenStackConfig

setProjectId() публичный Метод

Sets OpenStack project id
public setProjectId ( string $projectId )
$projectId string OpenStack project id

setProxySettings() публичный Метод

public setProxySettings ( array $proxySettings = null )
$proxySettings array

setRegion() публичный Метод

Sets OpenStack Region
public setRegion ( string $region ) : OpenStackConfig
$region string OpenStack Region
Результат OpenStackConfig

setRequestTimeout() публичный Метод

Sets request timeout for api calls
public setRequestTimeout ( integer $requestTimeout ) : OpenStackConfig
$requestTimeout integer Request timeout (in seconds)
Результат OpenStackConfig

setTenantName() публичный Метод

Sets OpenStack tenant name
public setTenantName ( string $tenantName ) : OpenStackConfig
$tenantName string OpenStack tenant name
Результат OpenStackConfig

setUpdateTokenCallback() публичный Метод

Sets update token callback
public setUpdateTokenCallback ( Closur\Closure $updateTokenCallback = null )
$updateTokenCallback Closur\Closure Update token callback must accept one argument - AuthToken

setUserId() публичный Метод

Sets OpenStack user id
public setUserId ( string $userId )
$userId string OpenStack user id

setUsername() публичный Метод

Sets username
public setUsername ( string $username ) : OpenStackConfig
$username string An User name.
Результат OpenStackConfig