All Classes and Interfaces
Class
Description
Represents a user or application delegate within the YellowDog Platform.
Represents a user account within the YellowDog Platform.
A builder that can be used to build a new Account that is automatically validated on build.
A builder that can be used to build a new AccountAllowance.
The API interface exposed by the YellowDog Account Service
The annotated String must be a valid account ID.
The annotated String must be a valid account qualified name.
The annotated String must be a valid account qualified namespace.
Derives from
ComputeSource to provide the interface for all Alibaba Cloud compute source model objects.Holds the Access Key ID and Secret Access Key which form a set of credentials for Alibaba Cloud.
A builder that can be used to build a new AlibabaCredential that is automatically validated on build.
Extends
Instance to add fields specific to the Alibaba Cloud compute sources.Defines a source of compute composed of Alibaba Cloud ECS instances.
A builder that can be used to build a new AlibabaInstancesComputeSource that is automatically validated on build.
The annotated String must be a valid instance tag value.
Defines the limit enforcement options for an empty allowance
Defines when, or if, an allowance will reset the used amount back to zero
Represents a user application within the YellowDog Platform.
The annotated String must be a valid compute attribute name.
A builder that can be used to build a new RequirementAllowance.
Holds the Role ARN and External ID required to allow YellowDog Platform to assume an assigned role in an external AWS account.
A builder that can be used to build a new AwsAccountRoleCredential that is automatically validated on build.
A builder that can be used to build a new AwsCapacityReservation that is automatically validated on build.
Derives from
ComputeSource to provide the interface for all AWS compute source model objects.Holds the Access Key ID and Secret Access Key which form a set of credentials for Amazon Web Services (AWS).
A builder that can be used to build a new AwsCredential that is automatically validated on build.
Defines a source of compute provisioned using an AWS EC2 Fleet request.
A builder that can be used to build a new AwsFleetComputeSource that is automatically validated on build.
A builder that can be used to build a new AwsFleetInstanceOverride that is automatically validated on build.
Specifies the order of the instance overrides that should be used in fulfilling On-Demand capacity.
A builder that can be used to build a new AwsFleetOnDemandOptions that is automatically validated on build.
A builder that can be used to build a new AwsFleetSpotOptions that is automatically validated on build.
Extends
Instance to add fields specific to the AWS compute sources.Defines a source of compute composed of AWS EC2 instances using the RunInstances API.
A builder that can be used to build a new AwsInstancesComputeSource that is automatically validated on build.
The annotated String must be a valid instance tag value.
A builder that can be used to build a new AwsPlacementGroup that is automatically validated on build.
A builder that can be used to build a new AwsSecondaryNetworkInterface that is automatically validated on build.
Holds the properties that form a set of credentials for Microsoft Azure.
A builder that can be used to build a new AzureClientCredential that is automatically validated on build.
Derives from
ComputeSource to provide the interface for all Azure compute source model objects.Extends
Instance to add fields specific to the Azure compute source.Holds an admin user name and password to be used for created instances in Microsoft Azure.
A builder that can be used to build a new AzureInstanceCredential that is automatically validated on build.
A builder that can be used to build a new AzureInstancesComputeSource that is automatically validated on build.
The annotated String must be a valid instance tag value.
A builder that can be used to build a new AzureScaleSetComputeSource that is automatically validated on build.
A builder that can be used to build a new AzureStorageCredential that is automatically validated on build.
The result of checking if the requestor has access to credentials named in Compute Sources within a Compute Requirement.
Thrown when a YellowDog service returns an HTTP 4xx error due to an issue with a request.
Enumerates Cloud Compute Providers.
The API interface exposed by the YellowDog Compute Service
Implementation of the ComputeClient interface
The interface implemented by all compute provision strategy model objects.
Defines the requirement for compute resource and chosen options for how to provision it.
A builder that can be used to build a new ComputeRequirement that is automatically validated on build.
A builder that can be used to build a new ComputeRequirementDynamicTemplate that is automatically validated on build.
Helper class to make it easier to write consumers of the
ComputeClient.The listener class for receiving compute source error events.
The event data for ComputeRequirementSourceErrorEventListener
A builder that can be used to build a new ComputeRequirementStaticTemplate that is automatically validated on build.
Describes the status of a compute requirement.
The listener class for receiving compute requirement status change events.
The event data for ComputeRequirementStatusChangedEventListener
Provides a summary of a ComputeRequirement including the ID that can be used to retrieve the full object.
Describes operations supported by a Compute Requirement based the traits of its compute sources.
The interface implemented by all compute source model objects.
Provides details for a compute source that is exhausted or nearing exhaustion.
Describes the status of a compute source.
A builder that can be used to build a new ComputeSourceTemplate that is automatically validated on build.
Describes behavioural traits specific to a compute source.
A builder that can be used to build a new ComputeSourceUsage that is automatically validated on build.
Defines properties to determine the behaviour that the Scheduler service should use when managing a configured worker pool.
A builder that can be used to build a new ConfiguredWorkerPoolProperties that is automatically validated on build.
Interface implemented by classes used to provide cloud provider-specific credentials to YellowDog Compute.
Summarizes how many credentials are available for a Compute Requirement
Interface implemented by entity classes that require credentials.
The annotated String must be a valid name.
Provides method-based validation via JSR-303 for objects of the target type.
Supports custom validators that check dependency relationships.
A builder that can be used to build a new DoubleRange that is automatically validated on build.
Represents an external user within the YellowDog Platform.
Indicates which path flattening strategy should be applied when downloading task inputs.
Derives from
ComputeSource to provide the interface for all Google Compute Engine (GCE) compute source model objects.The GCE instance behaviour to apply on a host maintenance event.
Extends
Instance to add fields specific to the Google Compute Engine (GCE) compute source.Defines a source of compute composed of Google Compute Engine (GCE) instances organised into an Instance Group.
A builder that can be used to build a new GceInstanceGroupComputeSource that is automatically validated on build.
Defines a source of compute composed of Google Compute Engine (GCE) instances individually provisioned.
A builder that can be used to build a new GceInstancesComputeSource that is automatically validated on build.
The annotated String must be a valid instance tag value.
The annotated String must be a valid general name.
The annotated String must be a valid general namespace.
A builder that can be used to build a new GoogleCloudCredential that is automatically validated on build.
A builder that can be used to build a new Group that is automatically validated on build.
A builder that can be used to build a new GroupRole that is automatically validated on build.
Interface implemented by all model types that have a system generated ID field for identification
Describes an instance provisioned for a compute requirement.
Represents the composite ID for an Instance
A builder that can be used to build a new InstanceId that is automatically validated on build.
Describes the status of a instance.
Provides summary counts for instances provisioned from a compute source.
The annotated String must be a valid instance tag key.
The annotated String must be a valid instance tag value.
A builder that can be used to build a new InstantRange that is automatically validated on build.
A builder that can be used to build a new IntegerRange that is automatically validated on build.
Represents an internal user within the YellowDog Platform.
Annotation to allow the definition of a custom JSON Schema "allowWildcard" property for a field.
Annotation to allow the definition of a custom JSON Schema "category" property for a field.
Annotation to allow the definition of a custom JSON Schema "credentialType" property for a field.
Annotation to allow the definition of custom JSON Schema "alias" and "aliasTitle" properties for a field.
Annotation to allow the definition of the JSON Schema "title" property for a type or field.
The annotated String must be a valid name.
A builder that can be used to build a new LongRange that is automatically validated on build.
Describes a machine software image, its capabilities and where it is available.
A builder that can be used to build a new MachineImage that is automatically validated on build.
Defines a family of versions of machine image groups.
A builder that can be used to build a new MachineImageFamily that is automatically validated on build.
Provides a summary of a Machine Image Family including the ID that can be used to retrieve the full object.
Defines a group of functionally equivalent machine images across different provider/region environments.
A builder that can be used to build a new MachineImageGroup that is automatically validated on build.
Represents a thread synchronization event that, when signaled, must be reset manually.
The annotated String must be a valid name.
Interface implemented by all model types that have a name field
The annotated String must be a valid namespace.
A builder that can be used to build a new NamespacePolicy that is automatically validated on build.
The API interface exposed by the YellowDog Namespaces Service
Describes an instance within a worker pool.
A builder that can be used to build a new NodeActionGroup that is automatically validated on build.
The status of the action queue for a specific node.
A builder that can be used to build a new NodeCreateWorkersAction that is automatically validated on build.
Describes the details of a worker pool node.
A builder that can be used to build a new NodeRunCommandAction that is automatically validated on build.
Indicates the status of a node.
A summary of a group of nodes.
A builder that can be used to build a new NodeType that is automatically validated on build.
A builder that can be used to build a new NodeWorkerTarget that is automatically validated on build.
A builder that can be used to build a new NodeWriteFileAction that is automatically validated on build.
A builder that can be used to build a new NumericAttributeConstraint that is automatically validated on build.
A builder that can be used to build a new NumericAttributeDefinition that is automatically validated on build.
A builder that can be used to build a new NumericAttributePreference.
A builder that can be used to build a new NumericAttributeRange that is automatically validated on build.
A builder that can be used to build a new NumericAttributeValue that is automatically validated on build.
Describes details about an object stored in the YellowDog Object Store service.
The annotated String must be a valid object name.
The annotated String must be a valid object name.
Derives from
ComputeSource to provide the interface for all AWS compute source model objects.Holds the properties that form a set of credentials for Oracle Cloud Infrastructure (OCI).
A builder that can be used to build a new OciCredential that is automatically validated on build.
Extends
Instance to add fields specific to the OCI compute sources.Defines a source of compute composed of OCI instances provisioned using the OCI Instance Pool API.
A builder that can be used to build a new OciInstancePoolComputeSource that is automatically validated on build.
Defines a source of compute composed of OCI instances provisioned individually.
A builder that can be used to build a new OciInstancesComputeSource that is automatically validated on build.
The annotated String must be a valid instance tag value.
The main API entry point for access YellowDog Platform Services.
A summary of a group of nodes.
A summary of a group of nodes.
Defines properties to determine the behaviour that the Scheduler service should use when managing a provisioned worker pool.
A builder that can be used to build a new ProvisionedWorkerPoolProperties that is automatically validated on build.
The annotated String must be a valid public scope qualified name.
The annotated String must be a valid public scope qualified namespace.
The annotated String must be a valid account or public scope qualified name.
The annotated String must be a valid account or public scope qualified namespace.
The annotated String must be a valid name.
A builder that can be used to build a new RequirementAllowance.
A builder that can be used to build a new RequirementAllowance.
Manages retry logic.
Defines properties that control services client retry behaviour
A builder that can be used to build a new RetryProperties that is automatically validated on build.
A builder that can be used to build a new Role that is automatically validated on build.
Specifies the behaviours to be used by the YellowDog Scheduler when executing Tasks within the associated TaskGroup.
A builder that can be used to build a new RunSpecification that is automatically validated on build.
Custom validator applied to task group run specifications.
Thrown when a YellowDog service returns an HTTP 5xx error due to a server error whilst processing the request.
Defines a set of URLs and request retry settings to be used to connect to YellowDog Platform Services.
A builder that can be used to build a new ServicesSchema that is automatically validated on build.
Defines a simulated source of compute that can be used to test the YellowDog Compute system.
A builder that can be used to build a new SimulatorComputeSource that is automatically validated on build.
Extends
Instance to add fields specific to the Simulator compute source.The annotated String must be a valid instance tag value.
Instructs YellowDog Compute to use a single compute source for the compute requirement.
A builder that can be used to build a new SingleSourceProvisionStrategy that is automatically validated on build.
A builder that can be used to build a new SourceAllowance.
A builder that can be used to build a new SourceAllowance.
Instructs YellowDog Compute to split the provision of instances as evenly as possible across the compute sources.
A builder that can be used to build a new SplitProvisionStrategy that is automatically validated on build.
A builder that can be used to build a new SetAttributeConstraint.
A builder that can be used to build a new StringAttributeDefinition that is automatically validated on build.
A builder that can be used to build a new StringAttributePreference.
A builder that can be used to build a new StringAttributeValue that is automatically validated on build.
Manages multiple listeners subscribing to the same logical instance of T (as opposed to specific object instance in memory).
The base interface for all YellowDog Platform server sent event listeners.
The annotated field should never be set, except by YellowDog Platform Services.
Interface implemented by all model types that have a tag field for user defined information
Defines a task to be executed as part of a WorkRequirement.
A builder that can be used to build a new Task that is automatically validated on build.
Holds details of an error that occurred during execution of the task.
Defines a group of tasks to be executed as part of a WorkRequirement.
A builder that can be used to build a new TaskGroup that is automatically validated on build.
Describes the status of a task group.
Defines task inputs to be downloaded prior to worker execution of the task.
A builder that can be used to build a new TaskInput that is automatically validated on build.
Defines the source contexts where task inputs can be found.
Custom validator applied to task inputs.
Indicates if the Scheduler should verify the existence of a task input prior to starting the task.
Describes the status of a task input that requires verification.
Defines task outputs to be uploaded following worker execution of the
A builder that can be used to build a new TaskOutput that is automatically validated on build.
Defines the source contexts where the task outputs can be found.
Custom validator applied to task outputs.
Describes the status of task.
Custom validator applied to tasks.
Provides a base for building event listeners that can track changes between successive subscription serversentevents.
Represents a user within the YellowDog Platform.
Provides an abstract base for Lombok generated builders that includes automatic validation of built objects.
The annotated class must satisfy any validation constraints defined on the specified custom validator class.
Defines several
ValidatedBy annotations on the same element.Performs custom validation of objects using type-specific concrete implementations of CustomValidator
A collection of validation groups.
A validation group that should be applied when an entity is new i.e.
Instructs YellowDog Compute to provision instances by acquiring the maximum available from each compute source in order,
until the required number of instances is reached.
A builder that can be used to build a new SplitProvisionStrategy that is automatically validated on build.
Client interface containing methods for accessing YellowDog Scheduler functions.
Implementation of the WorkClient interface.
Describes a Worker managed by the YellowDog Scheduler service.
Indicates the type of action that a worker has been instructed to perform
A pool of workers that are managed together.
Client interface containing methods for accessing YellowDog Scheduler functions.
Implementation of the WorkClient interface.
Helper class to make it easier to write consumers of the
WorkerPoolClient.A builder that can be used to build a new WorkerPoolNodeConfiguration that is automatically validated on build.
Indicates the status of a worker pool
Provides a summary of a WorkerPool including the ID that can be used to retrieve the full object.
Defines a secret token shared with an agent in advance of its registration.
Describes the current status of a Worker.
A summary of a group of workers.
Defines the requirement for work to be done with specifications on how it should be executed.
A builder that can be used to build a new WorkRequirement that is automatically validated on build.
Helper class to make it easier to write consumers of the
WorkClient.Describes the status of a work requirement.
Provides a summary of a WorkRequirement including the ID that can be used to retrieve the full object.
Custom validator applied to work requirements.
The annotated String must be a valid YellowDog ID (ydid).