OSClient (OpenStack4j Core 3.7 API)

All Known Subinterfaces:

OSClient.OSClientV2, OSClient.OSClientV3

All Known Implementing Classes:

OSClientSession.OSClientSessionV2, OSClientSession.OSClientSessionV3
```
public interface OSClient<T extends OSClient<T>>
```
A client which has been identified. Any calls spawned from this session will automatically utilize the original authentication that was successfully validated and authorized

Author:

Jeremy Unruh

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`OSClient.OSClientV2` OpenStack4j Client which authenticates against version V2
`static interface`	`OSClient.OSClientV3` OpenStack4j Client which authenticates against version V3

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ArtifactService`	`artifact()` Returns the Artifact Service API
`BarbicanService`	`barbican()` Returns the Barbican Service API
`BlockStorageService`	`blockStorage()` Returns the Block Storage Service API
`ComputeService`	`compute()` Returns the Compute Service API
`DNSService`	`dns()` Returns the DNS Service API
`GbpService`	`gbp()` Returns the Gbp Service API
`String`	`getEndpoint()` Gets the current endpoint of the Identity service
`Set<ServiceType>`	`getSupportedServices()` Gets the supported services.
`T`	`headers(Map<String,? extends Object> headers)` Passes the Headers for the current Session(Client)
`HeatService`	`heat()` Returns the Heat Service API
`ImageService`	`images()` Returns the Image Service API
`ImageService`	`imagesV2()` Returns the Image V2 Service API
`MagnumService`	`magnum()` Returns the Magnum Service API
`AppCatalogService`	`murano()` Returns the Murano Service API
`NetworkingService`	`networking()` Returns the Networking Service API
`ObjectStorageService`	`objectStorage()` Returns the Object Storage Service API
`OctaviaService`	`octavia()` Returns the Load Balancer Service API
`T`	`perspective(Facing perspective)` Changes the Perspective for the current Session (Client)
`T`	`removeRegion()` Removes the current region making all calls no longer resolving to region (if originally set otherwise no-op)
`SaharaService`	`sahara()` Returns the Sahara Service API
`SenlinService`	`senlin()` Returns the Senlin Service API
`ServiceFunctionChainService`	`sfc()` Returns the SFC Service API
`ShareService`	`share()` Returns the Shared File Systems API
`boolean`	`supportsBlockStorage()` Determines if the Block Storage (Cinder) service is supported
`boolean`	`supportsCompute()` Determines if the Compute (Nova) service is supported
`boolean`	`supportsHeat()` Determines if the Orchestration (Heat) service is supported
`boolean`	`supportsIdentity()` Determines if the Identity (Keystone) service is supported
`boolean`	`supportsImage()` Determines if the Image (Glance) service is supported
`boolean`	`supportsMurano()` Determines if the App Catalog (Murano) service is supported
`boolean`	`supportsNetwork()` Determines if the Network (Neutron) service is supported
`boolean`	`supportsObjectStorage()` Determines if the Object Storage (Swift) service is supported
`boolean`	`supportsShare()` Determines if the Shared File Systems (Manila) service is supported
`boolean`	`supportsTelemetry()` Determines if the Telemetry (Ceilometer) service is supported
`TackerService`	`tacker()` Returns the Tacker Service API
`TelemetryService`	`telemetry()` Returns the Telemetry Service API
`TroveService`	`trove()` Returns the Trove Service API
`T`	`useRegion(String region)` Specifies the region that should be used for further invocations with this client.
`WorkflowService`	`workflow()` Returns the Workflow Service API

- Method Detail
  - useRegion
```
T useRegion(String region)
```
    Specifies the region that should be used for further invocations with this client. If the region is invalid or doesn't exists execution errors will occur when invoking API calls and a RegionEndpointNotFoundException will be thrown
    
    Parameters:
    
    region - the region to use
    
    Returns:
    
    OSClient for method chaining
  - removeRegion
```
T removeRegion()
```
    Removes the current region making all calls no longer resolving to region (if originally set otherwise no-op)
    
    Returns:
    
    OSClient for method chaining
  - perspective
```
T perspective(Facing perspective)
```
    Changes the Perspective for the current Session (Client)
    
    Parameters:
    
    perspective - the new perspective
    
    Returns:
    
    OSClient for method chaining
  - headers
```
T headers(Map<String,? extends Object> headers)
```
    Passes the Headers for the current Session(Client)
    
    Parameters:
    
    headers - the headers to use for keystone tokenless
    
    Returns:
    
    OSClient for method chaining
  - getSupportedServices
```
Set<ServiceType> getSupportedServices()
```
    Gets the supported services. A set of ServiceTypes will be returned identifying the OpenStack services installed and supported
    
    Returns:
    
    the supported services
  - supportsCompute
```
boolean supportsCompute()
```
    Determines if the Compute (Nova) service is supported
    
    Returns:
    
    true, if supports compute
  - supportsIdentity
```
boolean supportsIdentity()
```
    Determines if the Identity (Keystone) service is supported
    
    Returns:
    
    true, if supports identity
  - supportsNetwork
```
boolean supportsNetwork()
```
    Determines if the Network (Neutron) service is supported
    
    Returns:
    
    true, if supports network
  - supportsImage
```
boolean supportsImage()
```
    Determines if the Image (Glance) service is supported
    
    Returns:
    
    true, if supports image
  - supportsHeat
```
boolean supportsHeat()
```
    Determines if the Orchestration (Heat) service is supported
    
    Returns:
    
    true if supports Heat
  - supportsMurano
```
boolean supportsMurano()
```
    Determines if the App Catalog (Murano) service is supported
    
    Returns:
    
    true if supports Murano
  - supportsBlockStorage
```
boolean supportsBlockStorage()
```
    Determines if the Block Storage (Cinder) service is supported
    
    Returns:
    
    true if supports Block Storage
  - supportsObjectStorage
```
boolean supportsObjectStorage()
```
    Determines if the Object Storage (Swift) service is supported
    
    Returns:
    
    true if supports Object Storage
  - supportsTelemetry
```
boolean supportsTelemetry()
```
    Determines if the Telemetry (Ceilometer) service is supported
    
    Returns:
    
    true if supports Telemetry
  - supportsShare
```
boolean supportsShare()
```
    Determines if the Shared File Systems (Manila) service is supported
    
    Returns:
    
    true if supports Shared File Systems
  - getEndpoint
```
String getEndpoint()
```
    Gets the current endpoint of the Identity service
    
    Returns:
    
    the endpoint
  - compute
```
ComputeService compute()
```
    Returns the Compute Service API
    
    Returns:
    
    the compute service
  - networking
```
NetworkingService networking()
```
    Returns the Networking Service API
    
    Returns:
    
    the networking service
  - sfc
```
ServiceFunctionChainService sfc()
```
    Returns the SFC Service API
    
    Returns:
    
    the Service Function Chain Service API
  - octavia
```
OctaviaService octavia()
```
    Returns the Load Balancer Service API
    
    Returns:
    
    the Load Balancer service
  - artifact
```
ArtifactService artifact()
```
    Returns the Artifact Service API
    
    Returns:
    
    the artifact service
  - tacker
```
TackerService tacker()
```
    Returns the Tacker Service API
    
    Returns:
    
    the tacker service
  - blockStorage
```
BlockStorageService blockStorage()
```
    Returns the Block Storage Service API
    
    Returns:
    
    the block storage service
  - objectStorage
```
ObjectStorageService objectStorage()
```
    Returns the Object Storage Service API
    
    Returns:
    
    the object storage service
  - images
```
ImageService images()
```
    Returns the Image Service API
    
    Returns:
    
    the image service
  - imagesV2
```
ImageService imagesV2()
```
    Returns the Image V2 Service API
    
    Returns:
    
    the image v2 service
  - telemetry
```
TelemetryService telemetry()
```
    Returns the Telemetry Service API
    
    Returns:
    
    the telemetry service
  - share
```
ShareService share()
```
    Returns the Shared File Systems API
    
    Returns:
    
    the share service
  - heat
```
HeatService heat()
```
    Returns the Heat Service API
    
    Returns:
    
    the Heat service
  - murano
```
AppCatalogService murano()
```
    Returns the Murano Service API
    
    Returns:
    
    the Murano service
  - sahara
```
SaharaService sahara()
```
    Returns the Sahara Service API
    
    Returns:
    
    the Sahara service
  - workflow
```
WorkflowService workflow()
```
    Returns the Workflow Service API
    
    Returns:
    
    the Workflow service
  - magnum
```
MagnumService magnum()
```
    Returns the Magnum Service API
    
    Returns:
    
    the Magnum Service
  - gbp
```
GbpService gbp()
```
    Returns the Gbp Service API
    
    Returns:
    
    the Gbp service
  - senlin
```
SenlinService senlin()
```
    Returns the Senlin Service API
    
    Returns:
    
    the Senlin service
  - trove
```
TroveService trove()
```
    Returns the Trove Service API
    
    Returns:
    
    the Trove service
  - barbican
```
BarbicanService barbican()
```
    Returns the Barbican Service API
    
    Returns:
    
    the Barbican service
  - dns
```
DNSService dns()
```
    Returns the DNS Service API
    
    Returns:
    
    the DNS service

Interface OSClient<T extends OSClient<T>>

Nested Class Summary

Method Summary

Method Detail

useRegion

removeRegion

perspective

headers

getSupportedServices

supportsCompute

supportsIdentity

supportsNetwork

supportsImage

supportsHeat

supportsMurano

supportsBlockStorage

supportsObjectStorage

supportsTelemetry

supportsShare

getEndpoint

compute

networking

sfc

octavia

artifact

tacker

blockStorage

objectStorage

images

imagesV2

telemetry

share

heat

murano

sahara

workflow

magnum

gbp

senlin

trove

barbican

dns