Class PlatformClient

java.lang.Object

co.yellowdog.platform.client.PlatformClient

All Implemented Interfaces:

AutoCloseable

public class PlatformClient
extends Object
implements AutoCloseable

The main API entry point for access YellowDog Platform Services.

Method Summary

Modifier and Type	Method	Description
AllowancesClient	allowancesClient()	Gets the client used to access the YellowDog Usage Allowances Service
void	close()	Releases any client resources, such as server sent event subscriptions.
CloudInfoClient	cloudInfoClient()	Gets the client used to access the YellowDog Cloud Info Service
ComputeClient	computeClient()	Gets the client used to access the YellowDog Compute Service
static PlatformClient	create(@NonNull ServicesSchema servicesSchema, @NonNull ApiKey key)	Constructs a new PlatformClient instance using the supplied ServicesSchema to connect to YellowDog
static PlatformClient	create(@NonNull ServicesSchema servicesSchema, @NonNull ApiKey key, @NonNull ObjectStoreClientConfigurationProperties objectStoreClientConfigurationProperties)
ImagesClient	imagesClient()	Gets the client used to access the YellowDog Images Service
KeyringClient	keyringClient()	Gets the client used to access the YellowDog Keyring Service
NamespacesClient	namespacesClient()	Gets the client used to access the YellowDog Cloud Namespaces Service
ObjectStoreClient	objectStoreClient()	Gets the client used to access the YellowDog Object Store Service
WorkClient	workClient()	Gets the client used to access the work component of the YellowDog Scheduler Service
WorkerPoolClient	workerPoolClient()	Gets the client used to access the worker pools component of the YellowDog Scheduler Service

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public static PlatformClient create(@NonNull
 @NonNull ServicesSchema servicesSchema,
 @NonNull
 @NonNull ApiKey key)

Constructs a new PlatformClient instance using the supplied ServicesSchema to connect to YellowDog

Parameters:

servicesSchema - the ServicesSchema that defines the base URLs to use to connect to YellowDog

Returns:

a new PlatformClient instance

create

public static PlatformClient create(@NonNull
 @NonNull ServicesSchema servicesSchema,
 @NonNull
 @NonNull ApiKey key,
 @NonNull
 @NonNull ObjectStoreClientConfigurationProperties objectStoreClientConfigurationProperties)

keyringClient

public KeyringClient keyringClient()

Gets the client used to access the YellowDog Keyring Service

Returns:

the client used to access the YellowDog Keyring Service

computeClient

public ComputeClient computeClient()

Gets the client used to access the YellowDog Compute Service

Returns:

the client used to access the YellowDog Compute Service

imagesClient

public ImagesClient imagesClient()

Gets the client used to access the YellowDog Images Service

Returns:

the client used to access the YellowDog Images Service

objectStoreClient

public ObjectStoreClient objectStoreClient()

Gets the client used to access the YellowDog Object Store Service

Returns:

the client used to access the YellowDog Object Store Service

workClient

public WorkClient workClient()

Gets the client used to access the work component of the YellowDog Scheduler Service

Returns:

the client used to access the work component of the YellowDog Scheduler Service

workerPoolClient

public WorkerPoolClient workerPoolClient()

Gets the client used to access the worker pools component of the YellowDog Scheduler Service

Returns:

the client used to access the worker pools component of the YellowDog Scheduler Service

allowancesClient

public AllowancesClient allowancesClient()

Gets the client used to access the YellowDog Usage Allowances Service

Returns:

the client used to access the YellowDog Usage Allowances Service

cloudInfoClient

public CloudInfoClient cloudInfoClient()

Gets the client used to access the YellowDog Cloud Info Service

Returns:

the client used to access the YellowDog Cloud Info Service

namespacesClient

public NamespacesClient namespacesClient()

Gets the client used to access the YellowDog Cloud Namespaces Service

Returns:

the client used to access the YellowDog Cloud Namespaces Service

close

public void close()

Releases any client resources, such as server sent event subscriptions.

Specified by:

close in interface AutoCloseable