Operation
extends AbstractModel
in package
Represents an API operation.
Table of Contents
Methods
- __construct() : mixed
- getContextParams() : array<string|int, mixed>
- Gets definition of modeled dynamic values used for endpoint resolution
- 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.
- getOperationContextParams() : array<string|int, mixed>
- Gets definition of modeled dynamic values used for endpoint resolution
- getOutput() : StructureShape
- Get the output shape of the operation.
- getStaticContextParams() : array<string|int, mixed>
- Gets static modeled static values used for endpoint resolution.
- offsetExists() : bool
- offsetGet() : mixed|null
- offsetSet() : void
- offsetUnset() : void
- toArray() : mixed
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
getContextParams()
Gets definition of modeled dynamic values used for endpoint resolution
public
getContextParams() : array<string|int, mixed>
Return values
array<string|int, 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
StructureShapegetOperationContextParams()
Gets definition of modeled dynamic values used for endpoint resolution
public
getOperationContextParams() : array<string|int, mixed>
Return values
array<string|int, mixed>getOutput()
Get the output shape of the operation.
public
getOutput() : StructureShape
Return values
StructureShapegetStaticContextParams()
Gets static modeled static values used for endpoint resolution.
public
getStaticContextParams() : array<string|int, mixed>
Return values
array<string|int, mixed>offsetExists()
public
offsetExists(mixed $offset) : bool
Parameters
- $offset : mixed
Return values
booloffsetGet()
public
offsetGet(mixed $offset) : mixed|null
Parameters
- $offset : mixed
Return values
mixed|nulloffsetSet()
public
offsetSet(mixed $offset, mixed $value) : void
Parameters
- $offset : mixed
- $value : mixed
offsetUnset()
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
toArray()
public
toArray() : mixed