CatalogItem
in package
This object represents an individual service catalog item - in other words an API Service. Each service has particular information which form the basis of how it distinguishes itself, and how it executes API operations.
Table of Contents
- $endpoints : array<string|int, mixed>
- $name : string
- $type : string
- factory() : CatalogItem
- Construct a CatalogItem from a mixed input.
- getEndpointFromRegion() : mixed
- Using a standard data object, extract its endpoint.
- getEndpoints() : array<string|int, mixed>
- getName() : string
- getType() : string
- hasName() : bool
- A basic string check.
- hasType() : bool
- setEndpoints() : $this
- setName() : $this
- setType() : $this
Properties
$endpoints
private
array<string|int, mixed>
$endpoints
= array()
$name
private
string
$name
$type
private
string
$type
Methods
factory()
Construct a CatalogItem from a mixed input.
public
static factory( $object) : CatalogItem
Parameters
Return values
CatalogItem —getEndpointFromRegion()
Using a standard data object, extract its endpoint.
public
getEndpointFromRegion(string $region[, bool $isRegionless = false ]) : mixed
Parameters
- $region : string
- $isRegionless : bool = false
Tags
Return values
mixed —getEndpoints()
public
getEndpoints() : array<string|int, mixed>
Return values
array<string|int, mixed> —getName()
public
getName() : string
Return values
string —getType()
public
getType() : string
Return values
string —hasName()
A basic string check.
public
hasName( $string) : bool
Parameters
Return values
bool —hasType()
public
hasType( $string) : bool
Parameters
Return values
bool —setEndpoints()
public
setEndpoints(array<string|int, mixed> $endpoints) : $this
Parameters
- $endpoints : array<string|int, mixed>
Return values
$this —setName()
public
setName( $name) : $this
Parameters
Return values
$this —setType()
public
setType( $type) : $this