Interface ServiceDescriptionInterface
A ServiceDescription stores service information based on a service document
- Guzzle\Service\Description\ServiceDescriptionInterface implements Serializable
Direct known implementers
Located at Guzzle/Service/Description/ServiceDescriptionInterface.php
Methods summary
-
public
getBaseUrl ( )
Get the basePath/baseUrl of the description
-
public
getOperations ( )
Get the API operations of the service
-
public
hasOperation ( string $name )
Check if the service has an operation by name
-
public
getOperation ( string $name )
Get an API operation by name
-
public
getModel ( string $id )
Get a specific model from the description
-
public
getModels ( )
Get all service description models
-
public
hasModel ( string $id )
Check if the description has a specific model by name
-
public
getApiVersion ( )
Get the API version of the service
-
public
getName ( )
Get the name of the API
-
public
getDescription ( )
Get a summary of the purpose of the API
-
public
getData ( string $key )
Get arbitrary data from the service description that is not part of the Guzzle spec
-
public
setData ( string $key, mixed $value )
Set arbitrary data on the service description
Methods detail
Get the basePath/baseUrl of the description
Returns
string
Get the API operations of the service
Returns
Check if the service has an operation by name
Parameters
- $name
string
$name Name of the operation to check
Returns
boolean
Get an API operation by name
Parameters
- $name
string
$name Name of the command
Returns
Get a specific model from the description
Parameters
- $id
string
$id ID of the model
Returns
Get all service description models
Returns
array
Check if the description has a specific model by name
Parameters
- $id
string
$id ID of the model
Returns
boolean
Get the API version of the service
Returns
string
Get the name of the API
Returns
string
Get a summary of the purpose of the API
Returns
string
Get arbitrary data from the service description that is not part of the Guzzle spec
Parameters
- $key
string
$key Data key to retrieve
Returns
null|mixed
public
Guzzle\Service\Description\ServiceDescriptionInterface
setData( string $key, mixed $value )
Set arbitrary data on the service description
Parameters
- $key
string
$key Data key to set- $value
mixed
$value Value to set