Interface Guzzle\Service\Description\ServiceDescriptionInterface

ExtendsSerializable
Implemented byGuzzle\Service\Description\ServiceDescription

A ServiceDescription stores service information based on a service document

Public Methods

Hide inherited methods

MethodDescriptionDefined By
getApiVersion() Get the API version of the service Guzzle\Service\Description\ServiceDescriptionInterface
getBaseUrl() Get the basePath/baseUrl of the description Guzzle\Service\Description\ServiceDescriptionInterface
getData() Get arbitrary data from the service description that is not part of the Guzzle spec Guzzle\Service\Description\ServiceDescriptionInterface
getDescription() Get a summary of the purpose of the API Guzzle\Service\Description\ServiceDescriptionInterface
getModel() Get a specific model from the description Guzzle\Service\Description\ServiceDescriptionInterface
getModels() Get all service description models Guzzle\Service\Description\ServiceDescriptionInterface
getName() Get the name of the API Guzzle\Service\Description\ServiceDescriptionInterface
getOperation() Get an API operation by name Guzzle\Service\Description\ServiceDescriptionInterface
getOperations() Get the API operations of the service Guzzle\Service\Description\ServiceDescriptionInterface
hasModel() Check if the description has a specific model by name Guzzle\Service\Description\ServiceDescriptionInterface
hasOperation() Check if the service has an operation by name Guzzle\Service\Description\ServiceDescriptionInterface
setData() Set arbitrary data on the service description Guzzle\Service\Description\ServiceDescriptionInterface

Method Details

getApiVersion() public abstract method

Get the API version of the service

public abstract string getApiVersion ( )
getBaseUrl() public abstract method

Get the basePath/baseUrl of the description

public abstract string getBaseUrl ( )
getData() public abstract method

Get arbitrary data from the service description that is not part of the Guzzle spec

public abstract null|mixed getData ( $key )
$key string

Data key to retrieve

getDescription() public abstract method

Get a summary of the purpose of the API

public abstract string getDescription ( )
getModel() public abstract method

Get a specific model from the description

public abstract Guzzle\Service\Description\Parameter|null getModel ( $id )
$id string

ID of the model

getModels() public abstract method

Get all service description models

public abstract array getModels ( )
getName() public abstract method

Get the name of the API

public abstract string getName ( )
getOperation() public abstract method

Get an API operation by name

public abstract Guzzle\Service\Description\OperationInterface|null getOperation ( $name )
$name string

Name of the command

getOperations() public abstract method

Get the API operations of the service

public abstract array getOperations ( )
return array

Returns an array of {@see OperationInterface} objects

hasModel() public abstract method

Check if the description has a specific model by name

public abstract bool hasModel ( $id )
$id string

ID of the model

hasOperation() public abstract method

Check if the service has an operation by name

public abstract bool hasOperation ( $name )
$name string

Name of the operation to check

setData() public abstract method

Set arbitrary data on the service description

public abstract self setData ( $key, $value )
$key string

Data key to set

$value mixed

Value to set