1. class
  2. OpenStack
  3. Identity
  4. v3
  5. Models
  6. Service

Service

class Service extends OperatorResource implements Creatable, Listable, Retrievable, Updateable, Deletable

Traits

OpenStack\Common\Api\OperatorTrait

Properties

$id string
$name string
$type string
$description string
$links

Methods

create (array $data) : Creatable

Create a new resource according to the configuration set in the options.

retrieve () : void

Retrieve details of the current resource from the remote API.

update () : void

Update the current resource with the configuration set out in the user options.

delete () : void

Permanently delete this resource.

getUrl (string $name, string $type, string $region, string $interface) : string|false

Retrieve the base URL for a service.

Details

View source
create(array $data)

Create a new resource according to the configuration set in the options.

Parameters

$data array {see \OpenStack\Identity\v3\Api::postServices}

Return value

Creatable

Example code

$creatable = $service->create($data);

View source
retrieve()

Retrieve details of the current resource from the remote API.

Return value

void

Example code

$service->retrieve();

View source
update()

Update the current resource with the configuration set out in the user options.

Return value

void

Example code

$service->update();

View source
delete()

Permanently delete this resource.

Return value

void

Example code

$service->delete();

View source
getUrl(string $name, string $type, string $region, string $interface)

Retrieve the base URL for a service.

Parameters

$name string The name of the service as it appears in the catalog.
$type string The type of the service as it appears in the catalog.
$region string The region of the service as it appears in the catalog.
$interface string The interface of the service as it appears in the catalog.

Return value

string|false

Example code

$response = $service->getUrl($name, $type, $region, $interface);