Package com.morpheusdata.core.cloud

Interface MorpheusCloudPoolService

All Superinterfaces:

MorpheusDataService<CloudPool,CloudPoolIdentity>, MorpheusIdentityService<CloudPoolIdentity>

public interface MorpheusCloudPoolService
extends MorpheusDataService<CloudPool,CloudPoolIdentity>, MorpheusIdentityService<CloudPoolIdentity>

Context methods for syncing CloudPool in Morpheus

This service is accessible in the MorpheusContext via the following traversal path:
morpheusContext.getAsync().getCloud().getPool()

Method Summary

Modifier and Type	Method	Description
io.reactivex.rxjava3.core.Maybe<CloudPool>	get(String poolId, Long accountId, Long siteId, Long zoneId)	Returns a pool from a pool ID string (usually starts with pool- or poolGroup-) obtained from user inputs.
io.reactivex.rxjava3.core.Observable<CloudPool>	listByCloudAndExternalIdIn(Long cloudId, Collection<String> externalIds)	Returns a list of all pools filtered by a cloud as well as a list of externalIds.
io.reactivex.rxjava3.core.Observable<CloudPoolIdentity>	listIdentityProjections(Long cloudId, String category, String regionCode)	Get a list of CloudPool projections based on Cloud id
io.reactivex.rxjava3.core.Observable<CloudPoolIdentity>	listSyncProjections(Long cloudId, String category)	Deprecated. replaced by {listIdentityProjections(Long, String, String)}

Methods inherited from interface com.morpheusdata.core.MorpheusDataService

bulkCreate, bulkRemove, bulkSave, count, create, create, find, get, list, listById, listOptions, remove, remove, save, save, search

Methods inherited from interface com.morpheusdata.core.MorpheusIdentityService

getIdentityProperties, listIdentityProjections

Method Details

listIdentityProjections

io.reactivex.rxjava3.core.Observable<CloudPoolIdentity> listIdentityProjections(Long cloudId,
 String category,
 String regionCode)

Get a list of CloudPool projections based on Cloud id

Parameters:

cloudId - Cloud id

category - filter by category

Returns:

Observable stream of sync projection

listSyncProjections

@Deprecated
io.reactivex.rxjava3.core.Observable<CloudPoolIdentity> listSyncProjections(Long cloudId,
 String category)

Deprecated.

replaced by {listIdentityProjections(Long, String, String)}

Get a list of CloudPool projections based on Cloud id

Parameters:

cloudId - Cloud id

category - filter by category

Returns:

Observable stream of sync projection

listByCloudAndExternalIdIn

io.reactivex.rxjava3.core.Observable<CloudPool> listByCloudAndExternalIdIn(Long cloudId,
 Collection<String> externalIds)

Returns a list of all pools filtered by a cloud as well as a list of externalIds. This is useful for chunked syncs where a cloud can contain a LARGE amount of pools

Parameters:

cloudId - the current id of the cloud we are filtering by

externalIds - a list of external ids to fetch by within the cloud scope

Returns:

Observable stream of CloudPools filtered by cloud and a collection of externalIds

get

io.reactivex.rxjava3.core.Maybe<CloudPool> get(String poolId,
 Long accountId,
 Long siteId,
 Long zoneId)

Returns a pool from a pool ID string (usually starts with pool- or poolGroup-) obtained from user inputs. In the case of a pool group ID a pool will be selected based on the group's selection mode

Parameters:

poolId -

accountId -

siteId -

zoneId -

Returns:

a cloud pool or null