Interface OperationInterface

Interface defining data objects that hold the information of an API operation

Guzzle\Service\Description\OperationInterface implements Guzzle\Common\ToArrayInterface

Direct known implementers

Guzzle\Service\Description\Operation

Namespace: Guzzle\Service\Description
Located at Guzzle/Service/Description/OperationInterface.php

Methods summary
`public Guzzle\Service\Description\ServiceDescriptionInterface\|null`	# `getServiceDescription( )` Get the service description that the operation belongs to Get the service description that the operation belongs to Returns `Guzzle\Service\Description\ServiceDescriptionInterface\|null`
`public Guzzle\Service\Description\OperationInterface`	# `setServiceDescription( Guzzle\Service\Description\ServiceDescriptionInterface $description )` Set the service description that the operation belongs to Set the service description that the operation belongs to Parameters `$description` `Guzzle\Service\Description\ServiceDescriptionInterface` $description Service description Returns `Guzzle\Service\Description\OperationInterface`
`public array`	# `getParams( )` Get the params of the operation Get the params of the operation Returns `array`
`public array`	# `getParamNames( )` Returns an array of parameter names Returns an array of parameter names Returns `array`
`public boolean`	# `hasParam( string $name )` Check if the operation has a specific parameter by name Check if the operation has a specific parameter by name Parameters `$name` `string` $name Name of the param Returns `boolean`
`public Guzzle\Service\Description\Parameter\|null`	# `getParam( string $param )` Get a single parameter of the operation Get a single parameter of the operation Parameters `$param` `string` $param Parameter to retrieve by name Returns `Guzzle\Service\Description\Parameter\|null`
`public string\|null`	# `getHttpMethod( )` Get the HTTP method of the operation Get the HTTP method of the operation Returns `string\|null`
`public string`	# `getClass( )` Get the concrete operation class that implements this operation Get the concrete operation class that implements this operation Returns `string`
`public string\|null`	# `getName( )` Get the name of the operation Get the name of the operation Returns `string\|null`
`public string\|null`	# `getSummary( )` Get a short summary of what the operation does Get a short summary of what the operation does Returns `string\|null`
`public string\|null`	# `getNotes( )` Get a longer text field to explain the behavior of the operation Get a longer text field to explain the behavior of the operation Returns `string\|null`
`public string\|null`	# `getDocumentationUrl( )` Get the documentation URL of the operation Get the documentation URL of the operation Returns `string\|null`
`public string\|null`	# `getResponseClass( )` Get what is returned from the method. Can be a primitive, class name, or model. For example, the responseClass could be 'array', which would inherently use a responseType of 'primitive'. Using a class name would set a responseType of 'class'. Specifying a model by ID will use a responseType of 'model'. Get what is returned from the method. Can be a primitive, class name, or model. For example, the responseClass could be 'array', which would inherently use a responseType of 'primitive'. Using a class name would set a responseType of 'class'. Specifying a model by ID will use a responseType of 'model'. Returns `string\|null`
`public string`	# `getResponseType( )` Get information about how the response is unmarshalled: One of 'primitive', 'class', 'model', or 'documentation' Get information about how the response is unmarshalled: One of 'primitive', 'class', 'model', or 'documentation' Returns `string`
`public string\|null`	# `getResponseNotes( )` Get notes about the response of the operation Get notes about the response of the operation Returns `string\|null`
`public boolean`	# `getDeprecated( )` Get whether or not the operation is deprecated Get whether or not the operation is deprecated Returns `boolean`
`public string`	# `getUri( )` Get the URI that will be merged into the generated request Get the URI that will be merged into the generated request Returns `string`
`public array`	# `getErrorResponses( )` Get the errors that could be encountered when executing the operation Get the errors that could be encountered when executing the operation Returns `array`
`public mixed\|null`	# `getData( string $name )` Get extra data from the operation Get extra data from the operation Parameters `$name` `string` $name Name of the data point to retrieve Returns `mixed\|null`

Methods inherited from Guzzle\Common\ToArrayInterface
`toArray()`

Constants summary
`string`	`TYPE_PRIMITIVE`	`'primitive'`	#
`string`	`TYPE_CLASS`	`'class'`	#
`string`	`TYPE_DOCUMENTATION`	`'documentation'`	#
`string`	`TYPE_MODEL`	`'model'`	#