Serialized Form

Package co.yellowdog.platform.account.credentials

Class co.yellowdog.platform.account.credentials.AwsAccountRoleCredential

class AwsAccountRoleCredential extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

externalId

@NotBlank String externalId

The external ID required to assume the external role.

externalRoleArn

@NotBlank String externalRoleArn

The ARN of the IAM role in the external account.

name

String name

Class co.yellowdog.platform.account.credentials.AwsCredential

class AwsCredential extends Object implements Serializable

serialVersionUID:

-309078713851318579L

Serialized Fields

accessKeyId

@NotBlank String accessKeyId

The AWS Access Key ID

description

String description

expiryTime

Instant expiryTime

The expiry time if this credential is temporary

name

String name

secretAccessKey

@NotBlank String secretAccessKey

The AWS Secret Access Key

sessionToken

String sessionToken

The AWS Session Token if this credential is temporary

Class co.yellowdog.platform.account.credentials.AzureClientCredential

class AzureClientCredential extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

clientId

@NotBlank String clientId

The Azure Client ID

description

String description

key

@NotBlank String key

The Azure Key

name

String name

subscriptionId

@NotBlank String subscriptionId

The Azure Subscription ID

tenantId

@NotBlank String tenantId

The Azure Tenant ID

Class co.yellowdog.platform.account.credentials.AzureInstanceCredential

class AzureInstanceCredential extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

adminPassword

String adminPassword

The admin password

adminUsername

@NotBlank String adminUsername

The admin username

description

String description

name

String name

Class co.yellowdog.platform.account.credentials.AzureStorageCredential

class AzureStorageCredential extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

accountKey

@NotBlank String accountKey

The Azure storage account key

accountName

@NotBlank String accountName

The Azure storage account name

description

String description

name

String name

Class co.yellowdog.platform.account.credentials.GoogleCloudCredential

class GoogleCloudCredential extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

serviceAccountKeyJson

@NotNull String serviceAccountKeyJson

The Google Cloud service account key JSON text

Class co.yellowdog.platform.account.credentials.OciCredential

class OciCredential extends Object implements Serializable

serialVersionUID:

-8686884904725700886L

Serialized Fields

description

String description

fingerprint

@NotBlank String fingerprint

The OCI public key fingerprint.

name

String name

passphrase

String passphrase

The OCI private key passphrase.

privateKey

@NotBlank String privateKey

The OCI private key.

tenantId

@NotBlank String tenantId

The OCI tenant ID (ocid).

userId

@NotBlank String userId

The OCI User ID (ocid).

Package co.yellowdog.platform.clients

Exception Class co.yellowdog.platform.clients.ClientErrorException

class ClientErrorException extends ServiceClientException implements Serializable

serialVersionUID:

1L

Exception Class co.yellowdog.platform.clients.NotAuthorisedException

class NotAuthorisedException extends ServiceClientException implements Serializable

serialVersionUID:

1L

Exception Class co.yellowdog.platform.clients.ServerErrorException

class ServerErrorException extends ServiceClientException implements Serializable

serialVersionUID:

1L

Exception Class co.yellowdog.platform.clients.ServiceClientException

class ServiceClientException extends RuntimeException implements Serializable

serialVersionUID:

1L

Serialized Fields

detail

List<String> detail

httpStatusCode

int httpStatusCode

Package co.yellowdog.platform.clients.configuration

Exception Class co.yellowdog.platform.clients.configuration.ServicesSchemaMissingUrlException

class ServicesSchemaMissingUrlException extends RuntimeException implements Serializable

serialVersionUID:

1L

Package co.yellowdog.platform.clients.objectstore

Exception Class co.yellowdog.platform.clients.objectstore.ObjectStoreClientException

class ObjectStoreClientException extends RuntimeException implements Serializable

serialVersionUID:

1L

Exception Class co.yellowdog.platform.clients.objectstore.ObjectTransferException

class ObjectTransferException extends ObjectStoreClientException implements Serializable

serialVersionUID:

1L

Serialized Fields

detail

List<String> detail

errorType

ErrorType errorType

Package co.yellowdog.platform.interaction.account

Class co.yellowdog.platform.interaction.account.GroupSummary

class GroupSummary extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

adminGroup

boolean adminGroup

description

String description

id

String id

name

String name

Class co.yellowdog.platform.interaction.account.KeyringSummary

class KeyringSummary extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

id

String id

name

String name

Class co.yellowdog.platform.interaction.account.RoleScope

class RoleScope extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

global

boolean global

namespaces

Set<@Namespace @NotBlank String> namespaces

Package co.yellowdog.platform.interaction.compute

Class co.yellowdog.platform.interaction.compute.ComputeRequirementTemplateSummary

class ComputeRequirementTemplateSummary extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

id

String id

name

String name

namespace

String namespace

strategyType

String strategyType

type

String type

Class co.yellowdog.platform.interaction.compute.ComputeSourceTemplateSummary

class ComputeSourceTemplateSummary extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

id

String id

name

String name

namespace

String namespace

provider

CloudProvider provider

sourceType

String sourceType

Class co.yellowdog.platform.interaction.compute.ExternalAttributeDefinition

class ExternalAttributeDefinition extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

definition

@NotNull @Valid AttributeDefinition definition

inputs

@NotEmpty List<@NotBlank String> inputs

Package co.yellowdog.platform.interaction.images

Class co.yellowdog.platform.interaction.images.MachineImageFamilySummary

class MachineImageFamilySummary extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

access

ImageAccess access

The access level for this machine image family and any contained groups and images.

createdTime

Instant createdTime

The date and time when the machine image family was first created.

id

String id

name

String name

The user allocated name used to uniquely identify the machine image family within its namespace.

namespace

String namespace

The user allocated namespace used to group machine image families and other objects together.

osType

ImageOsType osType

The operating system type of all images within this machine image family.

owned

Boolean owned

Indicates if the machine image family is owned by the authenticated account.

Package co.yellowdog.platform.interaction.objectstore

Class co.yellowdog.platform.interaction.objectstore.ObjectDownloadResponse

class ObjectDownloadResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

chunkCount

Integer chunkCount

chunkSize

Integer chunkSize

namespace

String namespace

objectName

String objectName

objectSize

Long objectSize

sessionId

String sessionId

Package co.yellowdog.platform.interaction.scheduler

Class co.yellowdog.platform.interaction.scheduler.WorkerPoolSummary

class WorkerPoolSummary extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

claimedWorkerCount

int claimedWorkerCount

The count of workers within the worker pool that have been claimed by one or more task groups.

createdTime

Instant createdTime

The date and time when the worker pool was first created.

healthy

boolean healthy

Indicates if the worker pool is healthy. If false then workers may be late or lost.

id

String id

name

String name

The name used to uniquely identify the worker pool.

namespace

String namespace

The namespace that the worker pool is associated with

registeredNodeCount

int registeredNodeCount

The count of nodes that have registered with the worker pool.

registeredWorkerCount

int registeredWorkerCount

The count of workers that have registered with the worker pool.

status

WorkerPoolStatus status

The status of the worker pool.

type

String type

The type of the worker pool.

workingWorkerCount

int workingWorkerCount

The count of workers within the worker pool that are currently doing a task.

Class co.yellowdog.platform.interaction.scheduler.WorkRequirementSummary

class WorkRequirementSummary extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

completedTaskCount

int completedTaskCount

The count of successfully completed tasks in the work requirement.

createdTime

Instant createdTime

The date and time when the work requirement was first submitted to YellowDog Scheduler.

healthy

boolean healthy

Indicates if the work requirement is healthy. If false then tasks may have failed or task groups may be starved.

id

String id

name

String name

The user allocated name used to uniquely identify the work requirement within its namespace.

namespace

String namespace

The user allocated namespace used to group work requirements and other objects together.

priority

double priority

The priority of the work requirement.

status

WorkRequirementStatus status

The status of the work requirement.

tag

String tag

totalTaskCount

int totalTaskCount

The total count of tasks in the work requirement.

Package co.yellowdog.platform.model

Class co.yellowdog.platform.model.AccessDelegate

class AccessDelegate extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

createdTime

Instant createdTime

creator

String creator

description

String description

id

@Ydid String id

permissions

GrantedPermissions permissions

subject

String subject

Class co.yellowdog.platform.model.Account

class Account extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

features

List<@NotNull Feature> features

id

String id

name

@Name @NotBlank String name

Class co.yellowdog.platform.model.AccountAuthenticationProperties

class AccountAuthenticationProperties extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

azure

@Valid AzureAccountAuthenticationProperties azure

okta

@Valid OktaAccountAuthenticationProperties okta

Class co.yellowdog.platform.model.Application

class Application extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

accessDelegates

List<@NotNull @Valid AccessDelegate> accessDelegates

createdByUserId

@Ydid @NotBlank String createdByUserId

description

String description

id

@Ydid String id

name

@Name @NotBlank String name

Class co.yellowdog.platform.model.AutoShutdown

class AutoShutdown extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

enabled

Boolean enabled

timeout

Duration timeout

Class co.yellowdog.platform.model.AwsCapacityReservation

class AwsCapacityReservation extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

groupArn

String groupArn

id

String id

preference

@NotNull AwsCapacityReservationPreference preference

Class co.yellowdog.platform.model.AwsFleetComputeSource

class AwsFleetComputeSource extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

assignPublicIp

boolean assignPublicIp

Indicates if provisioned instances should be assigned public IP addresses.

availabilityZone

String availabilityZone

The AWS availability zone within the region where instances will be provisioned.

bootVolumeSizeGb

Integer bootVolumeSizeGb

capacityReservation

@Valid AwsCapacityReservation capacityReservation

Specifies the capacity reservation to target for provisioned instances.

createClusterPlacementGroup

Boolean createClusterPlacementGroup

Indicates if instances should be provisioned within a cluster placement group.

createdFromId

String createdFromId

createElasticFabricAdapter

Boolean createElasticFabricAdapter

Indicates if instances should be provisioned with an Elastic Fabric Adapter network interface.

credential

String credential

enableDetailedMonitoring

Boolean enableDetailedMonitoring

Indicates if provisioned instances should have detailed CloudWatch monitoring enabled.

enableInstanceMetadataTags

Boolean enableInstanceMetadataTags

Indicates if provisioned instances should expose their tags via instance metadata.

exhaustion

ComputeSourceExhaustion exhaustion

existingPlacementGroup

AwsPlacementGroup existingPlacementGroup

Indicates an existing placement group within which instances should be provisioned.

fleetId

String fleetId

The ID of the AWS EC2 Fleet.

iamInstanceProfileArn

String iamInstanceProfileArn

The ARN of the IAM Instance Profile to use for the provisioned instances.

id

String id

imageId

String imageId

The region-specific Amazon Machine Image (AMI) ID for the image to use for the provisioned instances.

instanceOverrides

List<@NotNull @Valid AwsFleetInstanceOverride> instanceOverrides

Extra instance provision options that can override the main parameters set in this source.

instanceSummary

InstanceSummary instanceSummary

instanceTags

Map<@AwsInstanceTagKey String,@AwsInstanceTagValue String> instanceTags

instanceType

String instanceType

The EC2 instance type for the provisioned instances.

keyName

String keyName

The name of the EC2 key pair to use when logging into any instances provisioned from this source.

limit

int limit

maintainCapacity

boolean maintainCapacity

Indicates if AWS EC2 Fleet should maintain the instance count independently of YellowDog Compute, replacing the reprovision functionality.

name

String name

onDemandOptions

@Valid AwsFleetOnDemandOptions onDemandOptions

Options related to provisioning On-Demand instances.

purchaseOption

@NotNull AwsFleetPurchaseOption purchaseOption

Determines which instance purchase options (On-Demand and/or Spot) are available to AWS EC2 Fleet.

region

String region

The AWS region where instances will be provisioned.

rootDeviceName

String rootDeviceName

secondaryNetworkInterfaces

List<@NotNull @Valid AwsSecondaryNetworkInterface> secondaryNetworkInterfaces

Secondary network interfaces to create on provisioned instances.

securityGroupId

String securityGroupId

The ID of the AWS Security Group for the provisioned instances.

spotOptions

@Valid AwsFleetSpotOptions spotOptions

Options related to provisioning Spot instances.

status

ComputeSourceStatus status

statusMessage

String statusMessage

subnetId

String subnetId

The ID of the subnet to use for the provisioned instances.

supportingResourceCreated

Boolean supportingResourceCreated

userData

String userData

Class co.yellowdog.platform.model.AwsFleetInstanceOverride

class AwsFleetInstanceOverride extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

availabilityZone

String availabilityZone

The AWS availability zone within the region where instances will be provisioned.

instanceType

@NotBlank @Pattern(regexp="[^*]+",message="must specify an instance type") String instanceType

The EC2 instance type for the provisioned instances.

spotMaxPrice

@DecimalMin("0.00001") Double spotMaxPrice

The maximum price that will be paid for spot instances.

subnetId

String subnetId

The ID of the subnet to use for the provisioned instances.

Class co.yellowdog.platform.model.AwsFleetOnDemandOptions

class AwsFleetOnDemandOptions extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

allocationStrategy

AwsFleetOnDemandAllocationStrategy allocationStrategy

Determines the order of the instance overrides to use in fulfilling On-Demand capacity.

maxTotalPrice

@DecimalMin("0.00001") Double maxTotalPrice

The maximum amount per hour for On-Demand instances.

minInstanceCount

@Min(1L) Integer minInstanceCount

The minimum number of On-Demand instances that must be provisioned in the fleet.

singleAvailabilityZone

Boolean singleAvailabilityZone

Indicates that AWS EC2 Fleet should provision all On-Demand instances into a single availability zone.

singleInstanceType

Boolean singleInstanceType

Indicates that AWS EC2 Fleet should use a single instance type to provision all On-Demand instances.

useCapacityReservationsFirst

Boolean useCapacityReservationsFirst

Indicates if AWS EC2 Fleet should use unused Capacity Reservations to fulfill On-Demand capacity.

Class co.yellowdog.platform.model.AwsFleetSpotOptions

class AwsFleetSpotOptions extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

allocationStrategy

AwsFleetSpotAllocationStrategy allocationStrategy

Determines the order of the instance overrides to use in fulfilling Spot capacity.

instancePoolsToUseCount

Integer instancePoolsToUseCount

The number of Spot pools across which AWS EC2 Fleet should allocate Spot capacity when using LOWEST_PRICE Spot allocation strategy.

launchReplacementInstanceOnRebalance

Boolean launchReplacementInstanceOnRebalance

Allow AWS EC2 Fleet to launch a replacement Spot instance when an instance rebalance notification is emitted for an existing Spot instance.

maxTotalPrice

@DecimalMin("0.00001") Double maxTotalPrice

The maximum amount per hour for Spot instances.

minInstanceCount

@Min(1L) Integer minInstanceCount

The minimum number of Spot instances that must be provisioned in the fleet.

singleAvailabilityZone

Boolean singleAvailabilityZone

Indicates that AWS EC2 Fleet should provision all Spot instances into a single availability zone.

singleInstanceType

Boolean singleInstanceType

Indicates that AWS EC2 Fleet should use a single instance type to provision all Spot instances.

Class co.yellowdog.platform.model.AwsInstance

class AwsInstance extends Instance implements Serializable

serialVersionUID:

1L

Serialized Fields

instanceLifecycle

String instanceLifecycle

The AWS EC2 instance lifecycle value for this instance.

Class co.yellowdog.platform.model.AwsInstancesComputeSource

class AwsInstancesComputeSource extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

assignPublicIp

boolean assignPublicIp

Indicates if provisioned instances should be assigned public IP addresses.

availabilityZone

String availabilityZone

The AWS availability zone within the region where instances will be provisioned.

bootVolumeSizeGb

Integer bootVolumeSizeGb

capacityReservation

@Valid AwsCapacityReservation capacityReservation

Specifies the capacity reservation to target for provisioned instances.

createClusterPlacementGroup

Boolean createClusterPlacementGroup

Indicates if instances should be provisioned within a cluster placement group.

createdFromId

String createdFromId

createElasticFabricAdapter

Boolean createElasticFabricAdapter

Indicates if instances should be provisioned with an Elastic Fabric Adapter network interface.

credential

String credential

enableDetailedMonitoring

Boolean enableDetailedMonitoring

Indicates if provisioned instances should have detailed CloudWatch monitoring enabled.

enableInstanceMetadataTags

Boolean enableInstanceMetadataTags

Indicates if provisioned instances should expose their tags via instance metadata.

exhaustion

ComputeSourceExhaustion exhaustion

existingPlacementGroup

AwsPlacementGroup existingPlacementGroup

Indicates an existing placement group within which instances should be provisioned.

iamInstanceProfileArn

String iamInstanceProfileArn

The ARN of the IAM Instance Profile to use for the provisioned instances.

id

String id

imageId

String imageId

The region-specific Amazon Machine Image (AMI) ID for the image to use for the provisioned instances.

instanceSummary

InstanceSummary instanceSummary

instanceTags

Map<@AwsInstanceTagKey String,@AwsInstanceTagValue String> instanceTags

instanceType

String instanceType

The EC2 instance type for the provisioned instances.

keyName

String keyName

The name of the EC2 key pair to use when logging into any instances provisioned from this source.

limit

int limit

name

String name

region

String region

The AWS region where instances will be provisioned.

rootDeviceName

String rootDeviceName

secondaryNetworkInterfaces

List<@NotNull @Valid AwsSecondaryNetworkInterface> secondaryNetworkInterfaces

Secondary network interfaces to create on provisioned instances.

securityGroupId

String securityGroupId

The ID of the AWS Security Group for the provisioned instances.

specifyMinimum

boolean specifyMinimum

Indicates if YellowDog Compute should specify the minimum when requesting instances from AWS. If true, then no instances are provisioned unless all requested instances are available; otherwise, if false, YellowDog Compute will provision as many instances as possible up to the number requested from this compute source.

spot

boolean spot

Indicates if spot instances should be requested rather than on-demand.

spotMaxPrice

@DecimalMin("0.00001") Double spotMaxPrice

The maximum price that will be paid for instances provisioned from this source.

status

ComputeSourceStatus status

statusMessage

String statusMessage

subnetId

String subnetId

The ID of the subnet to use for the provisioned instances.

supportingResourceCreated

Boolean supportingResourceCreated

useCapacityBlock

Boolean useCapacityBlock

Indicates if instances should be provisioned within a reserved capacity block.

userData

String userData

Class co.yellowdog.platform.model.AwsPlacementGroup

class AwsPlacementGroup extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

groupId

String groupId

groupName

String groupName

Class co.yellowdog.platform.model.AwsSecondaryNetworkInterface

class AwsSecondaryNetworkInterface extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

networkInterfaceType

@NotNull AwsNetworkInterfaceType networkInterfaceType

Determines the type of the network interface.

securityGroupId

String securityGroupId

Optional securityGroupId for this network interface. If not specified the subnetId of the parent source is used.

subnetId

String subnetId

Optional subnetId for this network interface. If not specified the subnetId of the parent source is used.

Class co.yellowdog.platform.model.AzureAccountAuthenticationProperties

class AzureAccountAuthenticationProperties extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

clientId

@NotBlank String clientId

clientSecret

String clientSecret

enabled

boolean enabled

tenantId

@NotBlank String tenantId

Class co.yellowdog.platform.model.AzureInstance

class AzureInstance extends Instance implements Serializable

serialVersionUID:

1L

Serialized Fields

resourceId

String resourceId

Class co.yellowdog.platform.model.AzureInstancesComputeSource

class AzureInstancesComputeSource extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

adminUserCredential

String adminUserCredential

Optionally specifies the name of an AzureInstanceCredential that provides the admin user name and password to use for root (Linux) or administrator (Windows). If not specified, then YellowDog Compute uses the default admin user name and a different randomly generated password for each instance.

assignPublicIp

boolean assignPublicIp

availabilityZone

String availabilityZone

createdFromId

String createdFromId

createProximityPlacementGroup

Boolean createProximityPlacementGroup

Indicates if instances should be provisioned within a proximity placement group.

credential

String credential

environment

String environment

exhaustion

ComputeSourceExhaustion exhaustion

id

String id

imageId

String imageId

The YellowDog prefixed Azure image ID for the image to use for the provisioned instances.

instanceSummary

InstanceSummary instanceSummary

instanceTags

Map<@AzureInstanceTagKey String,@AzureInstanceTagValue String> instanceTags

limit

int limit

name

String name

networkName

String networkName

networkResourceGroupName

String networkResourceGroupName

region

String region

The Azure region where instances will be provisioned.

spotMaxPrice

Double spotMaxPrice

sshKey

String sshKey

The public SSH key. If provided, instances will be accessible with the matching private key through SSH.

status

ComputeSourceStatus status

statusMessage

String statusMessage

subnetName

String subnetName

supportingResourceCreated

Boolean supportingResourceCreated

useAcceleratedNetworking

Boolean useAcceleratedNetworking

Indicates if instances should be provisioned with a primary networking interface with accelerated networking.

userData

String userData

useSpot

Boolean useSpot

vmSize

String vmSize

Class co.yellowdog.platform.model.AzureNamespaceStorageConfiguration

class AzureNamespaceStorageConfiguration extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

containerName

@NotBlank String containerName

credential

@NotBlank @CredentialName String credential

namespace

@NotBlank @Namespace String namespace

Class co.yellowdog.platform.model.AzureScaleSetComputeSource

class AzureScaleSetComputeSource extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

adminUserCredential

String adminUserCredential

Optionally specifies the name of an AzureInstanceCredential that provides the admin user name and password to use for root (Linux) or administrator (Windows). If not specified, then YellowDog Compute uses the default admin user name and a different randomly generated password for each instance.

assignPublicIp

boolean assignPublicIp

availabilityZone

String availabilityZone

createdFromId

String createdFromId

createProximityPlacementGroup

Boolean createProximityPlacementGroup

Indicates if instances should be provisioned within a proximity placement group.

credential

String credential

environment

String environment

exhaustion

ComputeSourceExhaustion exhaustion

id

String id

imageId

String imageId

The YellowDog prefixed Azure image ID for the image to use for the provisioned instances.

instanceSummary

InstanceSummary instanceSummary

instanceTags

Map<@AzureInstanceTagKey String,@AzureInstanceTagValue String> instanceTags

limit

int limit

name

String name

networkName

String networkName

networkResourceGroupName

String networkResourceGroupName

region

String region

The Azure region where instances will be provisioned.

spotMaxPrice

Double spotMaxPrice

sshKey

String sshKey

The public SSH key. If provided, instances will be accessible with the matching private key through SSH.

status

ComputeSourceStatus status

statusMessage

String statusMessage

subnetName

String subnetName

supportingResourceCreated

Boolean supportingResourceCreated

useAcceleratedNetworking

Boolean useAcceleratedNetworking

Indicates if instances should be provisioned with a primary networking interface with accelerated networking.

userData

String userData

useSpot

Boolean useSpot

vmSize

String vmSize

Class co.yellowdog.platform.model.BestComputeSourceReport

class BestComputeSourceReport extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

constraints

Map<String,BestComputeSourceReportConstraint> constraints

createdTime

Instant createdTime

image

BestComputeSourceReportImage image

namespace

String namespace

preferences

Map<String,BestComputeSourceReportPreference> preferences

provisionedRequirementId

String provisionedRequirementId

rejectedSourceTemplateIds

List<String> rejectedSourceTemplateIds

requirementSupportedOperations

ComputeRequirementSupportedOperations requirementSupportedOperations

requirementTemplateId

String requirementTemplateId

selectedSourceTemplateIds

List<String> selectedSourceTemplateIds

sources

List<BestComputeSourceReportSource> sources

sourcesConsidered

int sourcesConsidered

sourcesSelected

int sourcesSelected

totalRanks

int totalRanks

Class co.yellowdog.platform.model.BestComputeSourceReportImage

class BestComputeSourceReportImage extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

availability

List<BestComputeSourceReportImageAvailability> availability

id

String id

osType

ImageOsType osType

suppliedId

String suppliedId

Class co.yellowdog.platform.model.BestComputeSourceReportImageAvailability

class BestComputeSourceReportImageAvailability extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

provider

CloudProvider provider

region

List<String> region

supportedInstanceTypes

List<String> supportedInstanceTypes

Class co.yellowdog.platform.model.BestComputeSourceReportNumericConstraint

class BestComputeSourceReportNumericConstraint extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

max

Number max

min

Number min

Class co.yellowdog.platform.model.BestComputeSourceReportPreference

class BestComputeSourceReportPreference extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

highestValue

Object highestValue

lowestValue

Object lowestValue

weight

Number weight

Class co.yellowdog.platform.model.BestComputeSourceReportSource

class BestComputeSourceReportSource extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,BestComputeSourceReportSourceAttribute> attributes

instanceType

String instanceType

name

String name

provider

CloudProvider provider

provisionedSourceId

String provisionedSourceId

rank

Integer rank

region

String region

sourceTemplateId

String sourceTemplateId

totalScore

Double totalScore

traits

ComputeSourceTraits traits

type

String type

Class co.yellowdog.platform.model.BestComputeSourceReportSourceAttribute

class BestComputeSourceReportSourceAttribute extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

percentile

Double percentile

score

Double score

value

Object value

Class co.yellowdog.platform.model.BestComputeSourceReportStringConstraint

class BestComputeSourceReportStringConstraint extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

anyOf

Set<String> anyOf

noneOf

Set<String> noneOf

pattern

String pattern

Class co.yellowdog.platform.model.ComputeRequirement

class ComputeRequirement extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

createdById

@Ydid String createdById

The ID of the User or Application that first submitted this compute requirement.

createdFromId

@Ydid String createdFromId

Gets the ID of the requirement template if this requirement was created from a template.

createdTime

Instant createdTime

The date and time when this compute requirement was first submitted to YellowDog Compute.

expectedInstanceCount

int expectedInstanceCount

The number of alive instances expected based on existing instances and the most recent provision action.

id

@Ydid String id

The ID of this compute requirement that is generated by YellowDog Compute when the requirement is first submitted.

maintainInstanceCount

boolean maintainInstanceCount

Indicates if the Compute Service should automatically attempt to provision new instances if the number of RUNNING instances is below the specified targetInstanceCount

name

@Name @NotBlank String name

The user allocated name used to uniquely identify this compute requirement within its namespace.

namespace

@Namespace @NotBlank String namespace

The user allocated namespace used to group compute requirements and other objects together.

nextStatus

ComputeRequirementStatus nextStatus

The next status of this compute requirement when a status transition is being requested.

provisionStrategy

@NotNull @Valid ComputeProvisionStrategy provisionStrategy

The compute provision strategy that YellowDog Compute must use when provisioning instances to meet this requirement.

status

ComputeRequirementStatus status

The status of this compute requirement.

statusChangedTime

Instant statusChangedTime

The date and time when the status or nextStatus last changed

supportedOperations

ComputeRequirementSupportedOperations supportedOperations

tag

String tag

targetInstanceCount

@Min(0L) int targetInstanceCount

The number of instances to be provisioned to meet this compute requirement.

Class co.yellowdog.platform.model.ComputeRequirementDynamicTemplate

class ComputeRequirementDynamicTemplate extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

constraints

List<@NotNull @Valid AttributeConstraint> constraints

description

String description

id

@Ydid String id

imagesId

String imagesId

instanceTags

Map<@InstanceTagKey String,@InstanceTagValue String> instanceTags

maximumSourceCount

@Min(1L) Integer maximumSourceCount

minimumSourceCount

@Min(1L) Integer minimumSourceCount

name

@NotBlank @Name String name

namespace

@Namespace String namespace

preferences

List<@NotNull @Valid AttributePreference> preferences

sourceNamespaces

List<@Namespace @NotBlank String> sourceNamespaces

sourceTraits

ComputeSourceTraitsFilter sourceTraits

strategyType

@NotBlank String strategyType

userData

String userData

Class co.yellowdog.platform.model.ComputeRequirementStaticTemplate

class ComputeRequirementStaticTemplate extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

id

@Ydid String id

imagesId

String imagesId

instanceTags

Map<@InstanceTagKey String,@InstanceTagValue String> instanceTags

name

@NotBlank @Name String name

namespace

@Namespace String namespace

sources

@NotEmpty List<@NotNull @Valid ComputeSourceUsage> sources

strategyType

@NotBlank String strategyType

userData

String userData

Class co.yellowdog.platform.model.ComputeRequirementSupportedOperations

class ComputeRequirementSupportedOperations extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

canReprovision

boolean canReprovision

canScaleOut

boolean canScaleOut

canStopStart

boolean canStopStart

Class co.yellowdog.platform.model.ComputeSourceExhaustion

class ComputeSourceExhaustion extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

expectedTermination

Instant expectedTermination

The expected termination time when an associated exhausted allowance's hard limit grace period will expire.

status

ComputeSourceExhaustionStatus status

If the source is associated with an exhausted allowance, gets the exhaustion status.

Class co.yellowdog.platform.model.ComputeSourceTemplate

class ComputeSourceTemplate extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

List<@NotNull @Valid AttributeValue<?>> attributes

description

String description

id

@Ydid String id

namespace

@Namespace String namespace

source

@Valid @NotNull ComputeSource source

Class co.yellowdog.platform.model.ComputeSourceTraits

class ComputeSourceTraits extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

canRestart

boolean canRestart

canScaleOut

boolean canScaleOut

canStopStart

boolean canStopStart

isSelfMaintained

boolean isSelfMaintained

Class co.yellowdog.platform.model.ConfiguredWorkerPool

class ConfiguredWorkerPool extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

awaitingNodes

boolean awaitingNodes

createdTime

Instant createdTime

expectedNodeCount

int expectedNodeCount

id

String id

name

String name

namespace

String namespace

nodeSummary

NodeSummary nodeSummary

properties

ConfiguredWorkerPoolProperties properties

status

WorkerPoolStatus status

statusChangedTime

Instant statusChangedTime

workerSummary

WorkerSummary workerSummary

Class co.yellowdog.platform.model.ConfiguredWorkerPoolProperties

class ConfiguredWorkerPoolProperties extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

metricsEnabled

Boolean metricsEnabled

nodeConfiguration

@Valid WorkerPoolNodeConfiguration nodeConfiguration

targetNodeCount

Integer targetNodeCount

The number of nodes that will be configured to register with this worker pool.

workerTag

String workerTag

Class co.yellowdog.platform.model.DoubleRange

class DoubleRange extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

max

Double max

min

Double min

Class co.yellowdog.platform.model.ExternalUser

class ExternalUser extends User implements Serializable

serialVersionUID:

1L

Serialized Fields

authenticationProvider

@NotNull AuthenticationProvider authenticationProvider

externalId

@NotBlank String externalId

Class co.yellowdog.platform.model.GceInstance

class GceInstance extends Instance implements Serializable

serialVersionUID:

1L

Serialized Fields

confidential

boolean confidential

preemptible

boolean preemptible

Class co.yellowdog.platform.model.GceInstanceGroupComputeSource

class GceInstanceGroupComputeSource extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

acceleratorCount

int acceleratorCount

acceleratorType

String acceleratorType

assignPublicIp

boolean assignPublicIp

Indicates if provisioned instances should be assigned public IP addresses.

confidential

boolean confidential

createdFromId

String createdFromId

credential

String credential

exhaustion

ComputeSourceExhaustion exhaustion

hostMaintenanceBehaviour

GceHostMaintenanceBehaviour hostMaintenanceBehaviour

id

String id

image

String image

instanceSummary

InstanceSummary instanceSummary

instanceTags

Map<@GceInstanceTagKey String,@GceInstanceTagValue String> instanceTags

limit

int limit

machineType

String machineType

name

String name

network

String network

preemptible

boolean preemptible

project

String project

region

String region

spot

boolean spot

sshKeys

String sshKeys

A list of public SSH keys. If provided, instances will be accessible with the matching private keys through SSH.

status

ComputeSourceStatus status

statusMessage

String statusMessage

subnetwork

String subnetwork

supportingResourceCreated

Boolean supportingResourceCreated

userData

String userData

zone

String zone

Class co.yellowdog.platform.model.GceInstancesComputeSource

class GceInstancesComputeSource extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

acceleratorCount

int acceleratorCount

acceleratorType

String acceleratorType

assignPublicIp

boolean assignPublicIp

Indicates if provisioned instances should be assigned public IP addresses.

confidential

boolean confidential

createCompactPlacementPolicy

Boolean createCompactPlacementPolicy

Indicates if instances should be provisioned using a compact placement policy.

createdFromId

String createdFromId

credential

String credential

exhaustion

ComputeSourceExhaustion exhaustion

hostMaintenanceBehaviour

GceHostMaintenanceBehaviour hostMaintenanceBehaviour

id

String id

image

String image

instanceSummary

InstanceSummary instanceSummary

instanceTags

Map<@GceInstanceTagKey String,@GceInstanceTagValue String> instanceTags

limit

int limit

machineType

String machineType

name

String name

network

String network

preemptible

boolean preemptible

project

String project

region

String region

specifyMinimum

boolean specifyMinimum

Indicates if YellowDog Compute should specify the minimum when requesting instances. NB: This can only be used with a limit set between 1..1000 If true, then no instances are provisioned unless all requested instances are available; otherwise, if false, YellowDog Compute will provision as many instances as possible up to the number requested from this compute source.

spot

boolean spot

sshKeys

String sshKeys

A list of public SSH keys. If provided, instances will be accessible with the matching private keys through SSH.

status

ComputeSourceStatus status

statusMessage

String statusMessage

subnetwork

String subnetwork

supportingResourceCreated

Boolean supportingResourceCreated

userData

String userData

zone

String zone

Class co.yellowdog.platform.model.GcsNamespaceStorageConfiguration

class GcsNamespaceStorageConfiguration extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

bucketName

@NotBlank String bucketName

credential

@NotBlank @CredentialName String credential

namespace

@NotBlank @Namespace String namespace

Class co.yellowdog.platform.model.GrantedPermissions

class GrantedPermissions extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

permissions

@Valid Map<@NotNull Permission,@NotNull GrantedPermissionScope> permissions

Class co.yellowdog.platform.model.GrantedPermissionScope

class GrantedPermissionScope extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

global

boolean global

namespaces

Set<@NotNull @Valid NamespaceRef> namespaces

Class co.yellowdog.platform.model.GroupRole

class GroupRole extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

role

@NotNull RoleSummary role

scope

@NotNull @Valid GrantedPermissionScope scope

Class co.yellowdog.platform.model.Instance

class Instance extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

createdTime

Instant createdTime

The date and time when this instance was first created.

hostname

String hostname

The hostname of this instance.

id

InstanceId id

The unique identifier for this instance formed from the YellowDog Compute Source ID and the provider supplied instance ID

imageId

String imageId

The machine image ID used for this instance.

instanceType

String instanceType

The machine type of this instance.

privateIpAddress

String privateIpAddress

The private IP address of this instance.

provider

CloudProvider provider

The cloud provider that supplies this instance.

publicIpAddress

String publicIpAddress

The public IP address of this instance.

region

String region

The region where this instance is provisioned.

spot

boolean spot

Indicates if this instance was provisioned via spot pricing vs on-demand.

status

InstanceStatus status

The status of this instance.

statusChangedTime

Instant statusChangedTime

The date and time when the status last changed

subregion

String subregion

The subregion where this instance is provisioned.

Class co.yellowdog.platform.model.InstanceId

class InstanceId extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

instanceId

@NotBlank String instanceId

The provider supplied ID for this instance.

sourceId

@Ydid @NotBlank String sourceId

The ID of the compute source from which this instance was provisioned.

Class co.yellowdog.platform.model.InstanceSummary

class InstanceSummary extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

expectedCount

int expectedCount

The number of alive instances expected from this compute source, based on existing instances and the most recent provision action.

expiredCount

int expiredCount

The count of TERMINATED instances that have expired and can no longer be retrieved from the platform.

lastUpdatedTime

Instant lastUpdatedTime

requestedCount

int requestedCount

The number of instances last requested from this compute source.

statusCounts

Map<InstanceStatus,Integer> statusCounts

A count of each status based on the non-expired instances that have been provisioned.

totalCount

int totalCount

The total count of all instances provisioned from this compute source (including expired instances).

Class co.yellowdog.platform.model.InstantRange

class InstantRange extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

max

Instant max

min

Instant min

Class co.yellowdog.platform.model.IntegerRange

class IntegerRange extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

max

Integer max

min

Integer min

Class co.yellowdog.platform.model.InternalUser

class InternalUser extends User implements Serializable

serialVersionUID:

1L

Serialized Fields

username

@Name @NotBlank String username

Class co.yellowdog.platform.model.KeyringCredential

class KeyringCredential extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

type

String type

Class co.yellowdog.platform.model.LongRange

class LongRange extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

max

Long max

min

Long min

Class co.yellowdog.platform.model.MachineImage

class MachineImage extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

createdTime

Instant createdTime

The date and time when this machine image record was first created. NB: This may not be indicative of the time the actual image was created.

id

@Ydid String id

metadata

Map<@MapKey String,String> metadata

A map of user-definable key-value pairs to hold extra metadata properties related to the machine image.

name

@Name @NotBlank String name

The machine image name

osType

@NotNull ImageOsType osType

The image operating system type

provider

@NotNull CloudProvider provider

The compute provider in whose system the image is registered.

providerImageId

@NotBlank String providerImageId

The ID for the image in the compute provider's system.

regions

List<@NotBlank String> regions

The regions in which the image is registered. If null or empty then the image is assumed to be available in all regions.

supportedInstanceTypes

List<@NotBlank String> supportedInstanceTypes

The instance types that can be used with the image in the cloud provider's system. If null or empty then the image is assumed to compatible with any instance type.

Class co.yellowdog.platform.model.MachineImageFamily

class MachineImageFamily extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

access

@NotNull ImageAccess access

The access level for this machine image family and any contained groups and images.

createdTime

Instant createdTime

The date and time when this machine image family was first created.

id

@Ydid String id

imageGroups

List<@NotNull @Valid MachineImageGroup> imageGroups

A list of the related machine image groups.

metadataSpecification

Map<@MapKey String,String> metadataSpecification

A map of user-definable key-value pairs used to specify metadata keys and, optionally, values required to be on all images within the machine image family.

name

@Name @NotBlank String name

The user allocated name used to uniquely identify this machine image family within its namespace.

namespace

@Namespace @NotBlank String namespace

The user allocated namespace used to group machine image families and other objects together.

osType

@NotNull ImageOsType osType

The operating system type of all images within this machine image family.

Class co.yellowdog.platform.model.MachineImageGroup

class MachineImageGroup extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

createdTime

Instant createdTime

The date and time when this machine image group was first created.

id

@Ydid String id

images

List<@NotNull @Valid MachineImage> images

A list of functionally equivalent machine images

metadataSpecification

Map<@MapKey String,String> metadataSpecification

A map of user-definable key-value pairs used to specify metadata keys and, optionally, values required to be on all images within the machine image group.

name

@Name @Pattern(regexp="(?i)^(?!latest$).*$",message="'latest' is reserved and cannot be used for the group name") @NotBlank String name

The user allocated name used to uniquely identify this machine image group within its family.

osType

@NotNull ImageOsType osType

The operating system type of all images within this machine image group.

Exception Class co.yellowdog.platform.model.ModelException

class ModelException extends RuntimeException implements Serializable

serialVersionUID:

1L

Class co.yellowdog.platform.model.Namespace

class Namespace extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

deletable

boolean deletable

id

@NotBlank @NamespaceId String id

namespace

@NotBlank @Namespace String namespace

Class co.yellowdog.platform.model.NamespacePolicy

class NamespacePolicy extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

autoscalingMaxNodes

@Min(0L) Integer autoscalingMaxNodes

namespace

@NotBlank @Namespace String namespace

Class co.yellowdog.platform.model.NamespaceRef

class NamespaceRef extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

id

@NotNull @NamespaceId String id

namespace

@NotNull @Namespace String namespace

Class co.yellowdog.platform.model.Node

class Node extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

actionQueueStatus

NodeActionQueueStatus actionQueueStatus

The status of the action queue for the node.

agentVersion

String agentVersion

deregisteredTime

Instant deregisteredTime

The time when the node was deregistered.

details

NodeDetails details

The details of the node.

id

String id

The ID of the node.

preemptionWarningTime

Instant preemptionWarningTime

The time when the node notified of preemption.

registeredTime

Instant registeredTime

The time when the node was registered.

status

NodeStatus status

The status of this instance.

statusChangedTime

Instant statusChangedTime

The date and time when the status last changed.

workerPoolId

String workerPoolId

The ID of the worker pool containing the node.

workers

List<Worker> workers

The workers on this instance.

Class co.yellowdog.platform.model.NodeActionGroup

class NodeActionGroup extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

actions

@NotEmpty List<@NotNull @Valid NodeAction> actions

Class co.yellowdog.platform.model.NodeCreateWorkersAction

class NodeCreateWorkersAction extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

nodeIdFilter

NodeIdFilter nodeIdFilter

nodeTypes

List<@NotBlank String> nodeTypes

nodeWorkers

@Valid NodeWorkerTarget nodeWorkers

totalWorkers

@Min(1L) Integer totalWorkers

Class co.yellowdog.platform.model.NodeDetails

class NodeDetails extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

hostname

String hostname

The hostname of the instance.

instanceId

@NotBlank String instanceId

The ID of the node's instance.

instanceType

String instanceType

The instance type of the instance.

nodeSlot

Integer nodeSlot

The slot number of this node within its node type if slot numbering has been configured.

nodeType

String nodeType

The node type of this node if node types have been configured.

privateIpAddress

String privateIpAddress

The private IP address of the instance.

provider

CloudProvider provider

The provider of the node's instance.

publicIpAddress

String publicIpAddress

The public IP address of the instance.

ram

Double ram

The amount of RAM in GB on the node's instance.

region

String region

The region in which the node's instance is running.

sourceName

String sourceName

The name of the compute source from which the node's instance was provisioned.

sourceNumber

Integer sourceNumber

The number of the compute source based on its order within the parent compute requirement.

supportedTaskTypes

List<@NotBlank String> supportedTaskTypes

The task types supported by this node.

vcpus

Double vcpus

The number of processors (threads) on the node's instance.

workerTag

String workerTag

An optional tag value that can be used to constrain worker allocation.

Class co.yellowdog.platform.model.NodeRunCommandAction

class NodeRunCommandAction extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

arguments

List<@NotNull String> arguments

environment

Map<@NotBlank String,String> environment

nodeIdFilter

NodeIdFilter nodeIdFilter

nodeTypes

List<@NotBlank String> nodeTypes

path

@NotBlank String path

Class co.yellowdog.platform.model.NodeSummary

class NodeSummary extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

actionQueueStatuses

Map<NodeActionQueueStatus,Long> actionQueueStatuses

The number of nodes with each action queue status.

lastUpdatedTime

Instant lastUpdatedTime

The last time this summary was updated.

statusCounts

Map<NodeStatus,Long> statusCounts

The number of nodes in each status.

Class co.yellowdog.platform.model.NodeType

class NodeType extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

count

@Min(1L) Integer count

min

@Min(1L) Integer min

name

@Name @NotBlank String name

slotNumbering

NodeSlotNumbering slotNumbering

sourceNames

List<@Name @NotBlank String> sourceNames

Class co.yellowdog.platform.model.NodeWorkerTarget

class NodeWorkerTarget extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

customTargetCommand

String customTargetCommand

targetCount

@Min(0L) Double targetCount

targetType

@NotNull NodeWorkerTargetType targetType

Class co.yellowdog.platform.model.NodeWriteFileAction

class NodeWriteFileAction extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

nodeIdFilter

NodeIdFilter nodeIdFilter

nodeTypes

List<@NotBlank String> nodeTypes

path

@NotBlank String path

Class co.yellowdog.platform.model.NumericAttributeDefinition

class NumericAttributeDefinition extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

defaultRankOrder

@NotNull NumericAttributeRankOrder defaultRankOrder

description

String description

name

String name

options

List<@NotNull Number> options

range

@Valid NumericAttributeRange range

title

String title

units

String units

Class co.yellowdog.platform.model.NumericAttributeRange

class NumericAttributeRange extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

max

Number max

min

Number min

Class co.yellowdog.platform.model.OciInstance

class OciInstance extends Instance implements Serializable

serialVersionUID:

1L

Serialized Fields

compartmentId

String compartmentId

The OCID of the compartment containing this instance.

flexOcpus

Float flexOcpus

The number of OCPUs provisioned on this flex type instance.

flexRam

Float flexRam

The amount of ram in GB provisioned on this flex type instance.

Class co.yellowdog.platform.model.OciInstancePoolComputeSource

class OciInstancePoolComputeSource extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

assignPublicIp

boolean assignPublicIp

Indicates if provisioned instances should be assigned public IP addresses.

availabilityDomain

String availabilityDomain

The OCI availability domain where instances will be provisioned.

compartmentId

String compartmentId

The OCI compartment ID (ocid) where instances will be provisioned.

createClusterNetwork

Boolean createClusterNetwork

createdFromId

String createdFromId

credential

String credential

exhaustion

ComputeSourceExhaustion exhaustion

flexOcpus

Float flexOcpus

flexRam

Float flexRam

id

String id

imageId

String imageId

The region-specific OCI Image ID (ocid) for the image to use for the provisioned instances.

instanceSummary

InstanceSummary instanceSummary

instanceTags

Map<@OciInstanceTagKey String,@OciInstanceTagValue String> instanceTags

limit

int limit

name

String name

region

String region

The OCI region where instances will be provisioned.

shape

String shape

sshKey

String sshKey

The public SSH key. If provided, instances will be accessible with the matching private key through SSH.

status

ComputeSourceStatus status

statusMessage

String statusMessage

subnetId

String subnetId

The region-specific OCI Subnet ID (ocid) for the subnet to use for the provisioned instances.

supportingResourceCreated

Boolean supportingResourceCreated

userData

String userData

Class co.yellowdog.platform.model.OciInstancesComputeSource

class OciInstancesComputeSource extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

assignPublicIp

boolean assignPublicIp

Indicates if provisioned instances should be assigned public IP addresses.

availabilityDomain

String availabilityDomain

The OCI availability domain where instances will be provisioned.

compartmentId

String compartmentId

The OCI compartment ID (ocid) where instances will be provisioned.

createdFromId

String createdFromId

credential

String credential

exhaustion

ComputeSourceExhaustion exhaustion

flexOcpus

Float flexOcpus

flexRam

Float flexRam

id

String id

imageId

String imageId

The region-specific OCI Image ID (ocid) for the image to use for the provisioned instances.

instanceSummary

InstanceSummary instanceSummary

instanceTags

Map<@OciInstanceTagKey String,@OciInstanceTagValue String> instanceTags

limit

int limit

name

String name

preemptible

boolean preemptible

region

String region

The OCI region where instances will be provisioned.

shape

String shape

sshKey

String sshKey

The public SSH key. If provided, instances will be accessible with the matching private key through SSH.

status

ComputeSourceStatus status

statusMessage

String statusMessage

subnetId

String subnetId

The region-specific OCI Subnet ID (ocid) for the subnet to use for the provisioned instances.

userData

String userData

Class co.yellowdog.platform.model.OciNamespaceStorageConfiguration

class OciNamespaceStorageConfiguration extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

bucketName

@NotBlank String bucketName

credential

@NotBlank @CredentialName String credential

namespace

@NotBlank @Namespace String namespace

ociNamespaceName

@NotBlank String ociNamespaceName

region

@NotBlank String region

Class co.yellowdog.platform.model.OktaAccountAuthenticationProperties

class OktaAccountAuthenticationProperties extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

clientId

@NotBlank String clientId

clientSecret

String clientSecret

domain

@NotBlank String domain

enabled

boolean enabled

Class co.yellowdog.platform.model.ProvisionedWorkerPool

class ProvisionedWorkerPool extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

awaitingNodes

boolean awaitingNodes

computeRequirementId

String computeRequirementId

The ID of the compute requirement used to provision the compute resource.

createdTime

Instant createdTime

expectedNodeCount

int expectedNodeCount

id

String id

name

String name

namespace

String namespace

nodeSummary

NodeSummary nodeSummary

properties

ProvisionedWorkerPoolProperties properties

status

WorkerPoolStatus status

statusChangedTime

Instant statusChangedTime

workerSummary

WorkerSummary workerSummary

Class co.yellowdog.platform.model.ProvisionedWorkerPoolProperties

class ProvisionedWorkerPoolProperties extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

createNodeWorkers

@Valid NodeWorkerTarget createNodeWorkers

How many workers to create on each node.

idleNodeShutdown

@Valid AutoShutdown idleNodeShutdown

Determines the auto shutdown behaviour applied for idle nodes.

idlePoolShutdown

@Valid AutoShutdown idlePoolShutdown

Determines the auto shutdown behaviour applied for an idle pool.

maxNodes

@Min(1L) Integer maxNodes

The maximum number of nodes that the worker pool can be scaled up to.

metricsEnabled

Boolean metricsEnabled

minNodes

@Min(0L) Integer minNodes

The minimum number of nodes that the worker pool can be scaled down to.

nodeBootTimeout

Duration nodeBootTimeout

The time given for a node to be registered before it is considered to have failed.

nodeConfiguration

@Valid WorkerPoolNodeConfiguration nodeConfiguration

workerTag

String workerTag

An optional tag value that will be attached to all workers in this pool and used to constrain worker allocation.

Class co.yellowdog.platform.model.RoleSummary

class RoleSummary extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

id

String id

name

String name

Class co.yellowdog.platform.model.RunSpecification

class RunSpecification extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

exclusiveWorkers

Boolean exclusiveWorkers

If true, then do not allow claimed Workers to be shared with other task groups; otherwise, Workers can be shared.

instanceTypes

List<@NotBlank String> instanceTypes

The machine instance types that can be used to execute tasks

maximumTaskRetries

@Min(0L) @Max(100L) int maximumTaskRetries

The maximum number of times a task can be retried after it has failed.

maxWorkers

@Min(1L) Integer maxWorkers

The maximum number of Workers that can be claimed for the associated TaskGroup.

minWorkers

@Min(0L) Integer minWorkers

The minimum number of Workers that the associated TaskGroup requires. This many workers must be claimed before the associated TaskGroup will start running.

namespaces

List<@NotBlank @Namespace String> namespaces

Constrains the YellowDog Scheduler to only execute tasks from the associated TaskGroup on nodes from worker pools in the specified namespaces.

providers

List<@NotNull CloudProvider> providers

Constrains the YellowDog Scheduler to only execute tasks from the associated TaskGroup on the specified providers.

ram

@Valid DoubleRange ram

Range constraint on GB of RAM that are required to execute tasks

regions

List<@NotBlank String> regions

Constrains the YellowDog Scheduler to only execute tasks from the associated TaskGroup in the specified regions.

retryableErrors

List<TaskErrorMatcher> retryableErrors

Defines the errors that should result in a task retrying if encountered.

tasksPerWorker

@Min(1L) Integer tasksPerWorker

Determines the number of worker claims based on splitting the number of unfinished tasks across workers.

taskTimeout

Duration taskTimeout

The maximum time that a worker should attempt to execute a task for before failing it. NB: This value can be overridden on individual tasks when they are added.

taskTypes

@NotEmpty List<@NotBlank String> taskTypes

The task types that will be used in the associated TaskGroup.

vcpus

@Valid DoubleRange vcpus

Range constraint on number of vCPUs that are required to execute tasks

workerTags

List<@NotBlank @Size(max=200) String> workerTags

Constrains the YellowDog Scheduler to only execute tasks from the associated TaskGroup on workers with a matching tag value.

Class co.yellowdog.platform.model.S3NamespaceStorageConfiguration

class S3NamespaceStorageConfiguration extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

bucketName

@NotBlank String bucketName

credential

@NotBlank @CredentialName String credential

namespace

@NotBlank @Namespace String namespace

region

@NotBlank String region

Class co.yellowdog.platform.model.SimulatorComputeSource

class SimulatorComputeSource extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

createdFromId

String createdFromId

credential

@CredentialName String credential

exhaustion

ComputeSourceExhaustion exhaustion

failOnProvision

boolean failOnProvision

failOnRequestAllInstances

boolean failOnRequestAllInstances

id

String id

imageId

String imageId

implicitCapacity

Integer implicitCapacity

The implicit capacity of this source that is not directly discoverable by the compute service, independent of limit.

instanceShutdownTimeSeconds

@Min(0L) int instanceShutdownTimeSeconds

The simulated shutdown time for an instance.

instanceShutdownTimeVariance

@Min(0L) @Max(1L) float instanceShutdownTimeVariance

A variance multiplier (from 0 to 1) applied randomly to the instance shutdown time.

instanceStartupTimeSeconds

@Min(0L) int instanceStartupTimeSeconds

The simulated startup time for an instance.

instanceStartupTimeVariance

@Min(0L) @Max(1L) float instanceStartupTimeVariance

A variance multiplier (from 0 to 1) applied randomly to the instance startup time.

instanceSummary

InstanceSummary instanceSummary

instanceTags

@Size(max=95) Map<@SimulatorInstanceTagKey String,@SimulatorInstanceTagValue String> instanceTags

instanceType

String instanceType

limit

int limit

name

String name

region

String region

reportSupportingResourcesExist

boolean reportSupportingResourcesExist

status

ComputeSourceStatus status

statusMessage

String statusMessage

unexpectedInstanceTerminationProbability

@Min(0L) @Max(1L) float unexpectedInstanceTerminationProbability

The probability (from 0 to 1) that any instance will be unexpectedly terminated whenever it is refreshed.

Class co.yellowdog.platform.model.SimulatorInstance

class SimulatorInstance extends Instance implements Serializable

serialVersionUID:

1L

Class co.yellowdog.platform.model.SingleSourceProvisionStrategy

class SingleSourceProvisionStrategy extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

sources

@Size(min=1,max=1,message="must contain exactly one compute source") List<@NotNull @Valid ComputeSource> sources

The compute sources to use for the compute requirement.

Class co.yellowdog.platform.model.SplitProvisionStrategy

class SplitProvisionStrategy extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

sources

List<@NotNull @Valid ComputeSource> sources

The compute sources to use for the compute requirement.

Class co.yellowdog.platform.model.StringAttributeDefinition

class StringAttributeDefinition extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

options

List<@NotBlank String> options

title

String title

Class co.yellowdog.platform.model.Task

class Task extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

abortRequestedTime

Instant abortRequestedTime

The time when task abort was requested.

arguments

List<@NotNull String> arguments

A list of arguments that will be passed to the task type run command when the task is executed.

data

@Valid TaskData data

Task data requirement specifications.

environment

Map<@MapKey String,String> environment

A map containing environment variable values that will be added to the process environment when the task is executed.

errors

List<TaskError> errors

finishedTime

Instant finishedTime

The time the task was finished.

flattenInputPaths

FlattenPath flattenInputPaths

Indicates if the input objects' paths should be flattened when they are downloaded.

fullyQualifiedName

String fullyQualifiedName

The system generated fully qualified name of the task in the form {namespace}/{workRequirementName}/{taskGroupName}/{taskName}. This is only generated if all ancestor entities are named.

id

@Ydid String id

inputs

List<@NotNull @Valid TaskInput> inputs

Input object specifications that determine objects to be downloaded prior to running the task.

name

@Name String name

The user allocated name used to uniquely identify the task within its task group.

outputs

List<@NotNull @Valid TaskOutput> outputs

Output object specifications that determine objects to be uploaded after running the task.

retryCount

Integer retryCount

How many times the task has failed and then been set back to WAITING to be retried.

startedTime

Instant startedTime

The time the task was last started by a Worker.

status

TaskStatus status

The task status.

tag

String tag

taskData

String taskData

The data to be passed to the Worker when the task is started.

taskGroupId

@Ydid String taskGroupId

taskType

@NotBlank String taskType

The type of the task, used to identify the program to use to execute the task.

timeout

Duration timeout

The maximum time that a worker should attempt to execute the task for before failing it.

workerId

@Ydid String workerId

Class co.yellowdog.platform.model.TaskData

class TaskData extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

inputs

List<@NotNull @Valid TaskDataInput> inputs

outputs

List<@NotNull @Valid TaskDataOutput> outputs

Class co.yellowdog.platform.model.TaskDataInput

class TaskDataInput extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

destination

@NotBlank @LocalDataPath String destination

source

@NotBlank @RemoteDataPath String source

Class co.yellowdog.platform.model.TaskDataOutput

class TaskDataOutput extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

alwaysUpload

boolean alwaysUpload

destination

@NotBlank @RemoteDataPath String destination

source

@NotBlank @LocalDataPath String source

Class co.yellowdog.platform.model.TaskError

class TaskError extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

error

@NotNull String error

A description of the error.

errorType

@NotNull String errorType

processExitCode

Integer processExitCode

statusAtFailure

TaskStatus statusAtFailure

timestamp

@NotNull Instant timestamp

The time at which the error occurred.

workerId

String workerId

The ID of the worker where the error occurred.

Class co.yellowdog.platform.model.TaskErrorMatcher

class TaskErrorMatcher extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

errorTypes

List<String> errorTypes

processExitCodes

List<Integer> processExitCodes

statusesAtFailure

List<TaskStatus> statusesAtFailure

Class co.yellowdog.platform.model.TaskGroup

class TaskGroup extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

completedTaskTtl

Duration completedTaskTtl

The time to live for completed tasks. If set, tasks that have been completed for longer than this period will be deleted.

dependencies

List<@Name @NotBlank String> dependencies

The names of other task groups within the same WorkRequirement that must be successfully completed before the task group is started.

dependentOn

@Name String dependentOn

Deprecated, for removal: This API element is subject to removal in a future version.

use TaskGroup.dependencies instead

The name of another task group within the same WorkRequirement that must be successfully completed before the task group is started.

finishIfAllTasksFinished

boolean finishIfAllTasksFinished

If true, the task group will finish automatically once all contained tasks are finished.

finishIfAnyTaskFailed

boolean finishIfAnyTaskFailed

If true, the task group will finish automatically if any contained tasks fail.

id

@Ydid String id

name

@Name @NotBlank String name

The user allocated name used to uniquely identify the task group within its work requirement.

priority

double priority

The task group priority.

runSpecification

@NotNull @Valid RunSpecification runSpecification

The run specification which determines the YellowDog Scheduler behaviours when it is executing the tasks within the task group.

starved

boolean starved

Indicates if the task group is unable to claim any workers.

status

TaskGroupStatus status

The task group status.

statusChangedTime

Instant statusChangedTime

The date and time when the status last changed

tag

String tag

taskSummary

TaskSummary taskSummary

waitingOnDependency

boolean waitingOnDependency

Indicates if the task group is waiting for a dependency task group to finish.

Class co.yellowdog.platform.model.TaskInput

class TaskInput extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

namespace

String namespace

The namespace containing matching objects; only if the source is set to TaskInputSource.OTHER_NAMESPACE.

objectNamePattern

@NotBlank String objectNamePattern

An ant-style pattern to select objects by name.

source

@NotNull TaskInputSource source

The source context where the inputs can be found.

verification

TaskInputVerification verification

Indicates if and how the Scheduler should verify the existence of a task input prior to starting the task.

verificationStatus

TaskInputVerificationStatus verificationStatus

The task input verification status.

Class co.yellowdog.platform.model.TaskOutput

class TaskOutput extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

alwaysUpload

boolean alwaysUpload

Indicates that the outputs should still be uploaded even if the task execution failed or was aborted.

directoryName

String directoryName

The pre-configured directory name; only if the source is set to TaskOutputSource.OTHER_DIRECTORY.

filePattern

String filePattern

An ant-style pattern to select output files by path.

required

boolean required

Indicates that at least one output should be found otherwise the task execution is failed.

source

@NotNull TaskOutputSource source

The source context where the outputs can be found.

Class co.yellowdog.platform.model.TaskSummary

class TaskSummary extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

lastUpdatedTime

Instant lastUpdatedTime

statusCounts

Map<TaskStatus,Integer> statusCounts

taskCount

int taskCount

Class co.yellowdog.platform.model.User

class User extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

accessDelegates

List<@NotNull @Valid AccessDelegate> accessDelegates

email

@Email String email

eulaAccepted

boolean eulaAccepted

id

@Ydid String id

name

@NotBlank String name

passwordSet

boolean passwordSet

Class co.yellowdog.platform.model.WaterfallProvisionStrategy

class WaterfallProvisionStrategy extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

sources

List<@NotNull @Valid ComputeSource> sources

The compute sources to use for the compute requirement.

Class co.yellowdog.platform.model.Worker

class Worker extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

claimCount

int claimCount

A count of the tasks groups which have claims on the worker. Always identical to the size of Worker.taskGroupIds.

currentTaskId

String currentTaskId

The ID of the task currently allocated to the worker.

exclusive

boolean exclusive

Indicates if the worker is exclusively claimed by a single task group.

id

String id

registeredTime

Instant registeredTime

The time at which the worker was registered.

status

WorkerStatus status

The status of the worker.

taskGroupIds

List<String> taskGroupIds

The IDs of the task groups which have claims on the worker.

Class co.yellowdog.platform.model.WorkerPoolNodeConfiguration

class WorkerPoolNodeConfiguration extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

nodeEvents

Map<@NotNull NodeEvent,@NotEmpty List<@NotNull @Valid NodeActionGroup>> nodeEvents

nodeTypes

List<@NotNull @Valid NodeType> nodeTypes

Class co.yellowdog.platform.model.WorkerPoolToken

class WorkerPoolToken extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

expiryTime

Instant expiryTime

The token expiry time.

secret

String secret

The token secret.

Class co.yellowdog.platform.model.WorkerSummary

class WorkerSummary extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

allWorkerClaimsCount

int allWorkerClaimsCount

The number of claims across all workers in this worker pool.

claimedWorkerCount

int claimedWorkerCount

The number of workers that are claimed.

lastClaimedTime

Instant lastClaimedTime

The last time one of these workers was claimed.

lastReleasedTime

Instant lastReleasedTime

The last time one of these workers was released.

lastUpdatedTime

Instant lastUpdatedTime

The last time this summary was updated.

statusCounts

Map<WorkerStatus,Long> statusCounts

The number of workers in each status.

Class co.yellowdog.platform.model.WorkRequirement

class WorkRequirement extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

createdTime

Instant createdTime

The date and time when the work requirement was first submitted to YellowDog Scheduler.

id

@Ydid String id

The ID of the work requirement that is generated by YellowDog Scheduler when the requirement is first submitted.

name

@Name @NotBlank String name

The user allocated name used to uniquely identify the work requirement within its namespace.

namespace

@Namespace @NotBlank String namespace

The user allocated namespace used to group work requirements and other objects together.

priority

double priority

The priority of the work requirement.

status

WorkRequirementStatus status

The status of the work requirement.

statusChangedTime

Instant statusChangedTime

The date and time when the status last changed

tag

String tag

taskGroups

@Size(max=1000) List<@NotNull @Valid TaskGroup> taskGroups

The task groups containing tasks to be executed.