Operation
extends AbstractModel
in package
Represents an API operation.
Table of Contents
- $definition : array<string|int, mixed>
- $shapeMap : ShapeMap
- $errors : mixed
- $input : mixed
- $output : mixed
- __construct() : mixed
- getErrors() : array<string|int, Shape>
- Get an array of operation error shapes.
- getHttp() : array<string|int, mixed>
- Returns an associative array of the HTTP attribute of the operation:
- getInput() : StructureShape
- Get the input shape of the operation.
- getOutput() : StructureShape
- Get the output shape of the operation.
- offsetExists() : mixed
- offsetGet() : mixed
- offsetSet() : mixed
- offsetUnset() : mixed
- toArray() : mixed
- shapeAt() : mixed
- shapeFor() : mixed
Properties
$definition
protected
array<string|int, mixed>
$definition
$shapeMap
protected
ShapeMap
$shapeMap
$errors
private
mixed
$errors
$input
private
mixed
$input
$output
private
mixed
$output
Methods
__construct()
public
__construct(array<string|int, mixed> $definition, ShapeMap $shapeMap) : mixed
Parameters
- $definition : array<string|int, mixed>
-
Service description
- $shapeMap : ShapeMap
-
Shapemap used for creating shapes
Return values
mixed —getErrors()
Get an array of operation error shapes.
public
getErrors() : array<string|int, Shape>
Return values
array<string|int, Shape> —getHttp()
Returns an associative array of the HTTP attribute of the operation:
public
getHttp() : array<string|int, mixed>
- method: HTTP method of the operation
- requestUri: URI of the request (can include URI template placeholders)
Return values
array<string|int, mixed> —getInput()
Get the input shape of the operation.
public
getInput() : StructureShape
Return values
StructureShape —getOutput()
Get the output shape of the operation.
public
getOutput() : StructureShape
Return values
StructureShape —offsetExists()
public
offsetExists(mixed $offset) : mixed
Parameters
- $offset : mixed
Return values
mixed —offsetGet()
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
Return values
mixed —offsetSet()
public
offsetSet(mixed $offset, mixed $value) : mixed
Parameters
- $offset : mixed
- $value : mixed
Return values
mixed —offsetUnset()
public
offsetUnset(mixed $offset) : mixed
Parameters
- $offset : mixed
Return values
mixed —toArray()
public
toArray() : mixed
Return values
mixed —shapeAt()
protected
shapeAt(mixed $key) : mixed
Parameters
- $key : mixed
Return values
mixed —shapeFor()
protected
shapeFor(array<string|int, mixed> $definition) : mixed
Parameters
- $definition : array<string|int, mixed>