1. class
  2. OpenStack
  3. Metric
  4. v1
  5. Gnocchi
  6. Service

Service

class Service extends AbstractService

Gnocci Metric v1 Service class

Traits

OpenStack\Common\Api\OperatorTrait

Methods

listResourceTypes () : Generator

Retrieves a collection of \OpenStack\Metric\v1\Gnocchi\Models\ResourceType type in a generator format.

listResources (array $options = array()) : Generator

Retrieves a collection of \OpenStack\Metric\v1\Gnocchi\Models\Resource type in a generator format.

getResource (array $options = array()) : Resource

Retrieves a Resource object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.

searchResources (array $options = array()) : Generator

Retrieves a collection of \OpenStack\Metric\v1\Gnocchi\Models\Resource type in a generator format.

getMetric (string $id) : Metric

Retrieves a Metric object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.

listMetrics (array $options = array()) : Generator

Retrieves a collection of Metric type in a generator format.

Details

View source
listResourceTypes()

Retrieves a collection of \OpenStack\Metric\v1\Gnocchi\Models\ResourceType type in a generator format.

Return value

Generator

Example code

$generator = $service->listResourceTypes();

View source
listResources(array $options = array())

Retrieves a collection of \OpenStack\Metric\v1\Gnocchi\Models\Resource type in a generator format.

Parameters

$options array {see \OpenStack\Metric\v1\Gnocchi\Api::getResources}

Return value

Generator

Example code

$generator = $service->listResources($options);

View source
getResource(array $options = array())

Retrieves a Resource object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.

Parameters

$options array

Return value

Resource

Example code

$resource = $service->getResource($options);

View source
searchResources(array $options = array())

Retrieves a collection of \OpenStack\Metric\v1\Gnocchi\Models\Resource type in a generator format.

Parameters

$options array {see \OpenStack\Metric\v1\Gnocchi\Api::searchResources}

Return value

Generator

Example code

$generator = $service->searchResources($options);

View source
getMetric(string $id)

Retrieves a Metric object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.

Parameters

$id string

Return value

Metric

Example code

$metric = $service->getMetric($id);

View source
listMetrics(array $options = array())

Retrieves a collection of Metric type in a generator format.

Parameters

$options array {see \OpenStack\Metric\v1\Gnocchi\Api::getMetrics}

Return value

Generator

Example code

$generator = $service->listMetrics($options);