IOCMProvider
extends
JsonSerializable
in
Model based on the Open Cloud Mesh Discovery API
Tags
Table of Contents
Methods
- addResourceType() : $this
- add a single resource to the object
- createNewResourceType() : IOCMResource
- create a new resource to later add it with {@see addResourceType()}
- extractProtocolEntry() : string
- extract a specific string value from the listing of protocols, based on resource-name and protocol-name
- getApiVersion() : string
- returns API version
- getEndPoint() : string
- get configured endpoint
- getResourceTypes() : array<string|int, IOCMResource>
- get all set resources
- import() : $this
- import data from an array
- isEnabled() : bool
- is set as enabled ?
-
jsonSerialize()
: array{enabled: bool, apiVersion: string, endPoint: string, resourceTypes: array{name: string, shareTypes: string[], protocols: array
}[]} - setApiVersion() : $this
- get set API Version
- setEnabled() : $this
- enable OCM
- setEndPoint() : $this
- configure endpoint
- setResourceTypes() : $this
- set resources
Methods
addResourceType()
add a single resource to the object
public
addResourceType(IOCMResource $resource) : $this
Parameters
- $resource : IOCMResource
Tags
Return values
$thiscreateNewResourceType()
create a new resource to later add it with {@see addResourceType()}
public
createNewResourceType() : IOCMResource
Tags
Return values
IOCMResourceextractProtocolEntry()
extract a specific string value from the listing of protocols, based on resource-name and protocol-name
public
extractProtocolEntry(string $resourceName, string $protocol) : string
Parameters
- $resourceName : string
- $protocol : string
Tags
Return values
stringgetApiVersion()
returns API version
public
getApiVersion() : string
Tags
Return values
stringgetEndPoint()
get configured endpoint
public
getEndPoint() : string
Tags
Return values
stringgetResourceTypes()
get all set resources
public
getResourceTypes() : array<string|int, IOCMResource>
Tags
Return values
array<string|int, IOCMResource>import()
import data from an array
public
import(array<string, int|string|bool|array<string|int, mixed>> $data) : $this
Parameters
- $data : array<string, int|string|bool|array<string|int, mixed>>
Tags
Return values
$thisisEnabled()
is set as enabled ?
public
isEnabled() : bool
Tags
Return values
booljsonSerialize()
public
jsonSerialize() : array{enabled: bool, apiVersion: string, endPoint: string, resourceTypes: array{name: string, shareTypes: string[], protocols: array}[]}
Tags
Return values
array{enabled: bool, apiVersion: string, endPoint: string, resourceTypes: array{name: string, shareTypes: string[], protocols: arraysetApiVersion()
get set API Version
public
setApiVersion(string $apiVersion) : $this
Parameters
- $apiVersion : string
Tags
Return values
$thissetEnabled()
enable OCM
public
setEnabled(bool $enabled) : $this
Parameters
- $enabled : bool
Tags
Return values
$thissetEndPoint()
configure endpoint
public
setEndPoint(string $endPoint) : $this
Parameters
- $endPoint : string
Tags
Return values
$thissetResourceTypes()
set resources
public
setResourceTypes(array<string|int, IOCMResource> $resourceTypes) : $this
Parameters
- $resourceTypes : array<string|int, IOCMResource>