Uses of Annotation Type
co.yellowdog.platform.model.json.JsonTitle

Packages that use JsonTitle

Package	Description
co.yellowdog.platform.account.credentials	Defines types to hold credentials specific to each cloud provider.
co.yellowdog.platform.model	Provides the types that define the YellowDog Platform data model.

Uses of JsonTitle in co.yellowdog.platform.account.credentials

Classes in co.yellowdog.platform.account.credentials with annotations of type JsonTitle

Modifier and Type	Class	Description
final class	AlibabaCredential	Holds the Access Key ID and Secret Access Key which form a set of credentials for Alibaba Cloud.
final class	AwsAccountRoleCredential	Holds the Role ARN and External ID required to allow YellowDog Platform to assume an assigned role in an external AWS account.
final class	AwsCredential	Holds the Access Key ID and Secret Access Key which form a set of credentials for Amazon Web Services (AWS).
final class	AzureClientCredential	Holds the properties that form a set of credentials for Microsoft Azure.
final class	AzureInstanceCredential	Holds an admin user name and password to be used for created instances in Microsoft Azure.
final class	AzureStorageCredential
final class	GoogleCloudCredential
final class	OciCredential	Holds the properties that form a set of credentials for Oracle Cloud Infrastructure (OCI).

Methods in co.yellowdog.platform.account.credentials with annotations of type JsonTitle

Modifier and Type	Method	Description
String	Credential.getDescription()
@Name @NotBlank @Pattern(regexp="[a-z](?:[a-z\\d_-]{0,58}[a-z\\d])?") @Size(max=60) String	Credential.getName()	Returns the name assigned to the Credential to identify it to the ComputeServiceClient.

Uses of JsonTitle in co.yellowdog.platform.model

Classes in co.yellowdog.platform.model with annotations of type JsonTitle

Modifier and Type	Class	Description
class	AlibabaInstancesComputeSource	Defines a source of compute composed of Alibaba Cloud ECS instances.
class	AlibabaNamespaceStorageConfiguration
class	AwsCapacityReservation
class	AwsFleetComputeSource	Defines a source of compute provisioned using an AWS EC2 Fleet request.
class	AwsFleetInstanceOverride
class	AwsFleetOnDemandOptions
class	AwsFleetSpotOptions
class	AwsInstancesComputeSource	Defines a source of compute composed of AWS EC2 instances using the RunInstances API.
class	AwsPlacementGroup
class	AwsSecondaryNetworkInterface
class	AzureInstancesComputeSource
class	AzureNamespaceStorageConfiguration
class	AzureScaleSetComputeSource
class	GceInstanceGroupComputeSource	Defines a source of compute composed of Google Compute Engine (GCE) instances organised into an Instance Group.
class	GceInstancesComputeSource	Defines a source of compute composed of Google Compute Engine (GCE) instances individually provisioned.
class	GcsNamespaceStorageConfiguration
class	OciInstancePoolComputeSource	Defines a source of compute composed of OCI instances provisioned using the OCI Instance Pool API.
class	OciInstancesComputeSource	Defines a source of compute composed of OCI instances provisioned individually.
class	OciNamespaceStorageConfiguration
class	S3NamespaceStorageConfiguration
class	SimulatorComputeSource	Defines a simulated source of compute that can be used to test the YellowDog Compute system.

Methods in co.yellowdog.platform.model with annotations of type JsonTitle

Modifier and Type	Method	Description
int	GceComputeSource.getAcceleratorCount()
String	GceComputeSource.getAcceleratorType()
String	AzureComputeSource.getAdminUserCredential()
String	OciComputeSource.getAvailabilityDomain()	The OCI availability domain where instances will be provisioned.
String	AlibabaComputeSource.getAvailabilityZone()	The Alibaba Cloud availability zone within the region where instances will be provisioned.
String	AwsComputeSource.getAvailabilityZone()
String	AzureComputeSource.getAvailabilityZone()
AwsCapacityReservation	AwsComputeSource.getCapacityReservation()
@NotBlank String	OciComputeSource.getCompartmentId()	The OCI compartment ID (ocid) where instances will be provisioned.
Boolean	AwsComputeSource.getCreateClusterPlacementGroup()
Boolean	AwsComputeSource.getCreateElasticFabricAdapter()
Boolean	AzureComputeSource.getCreateProximityPlacementGroup()
@CredentialName String	ComputeSource.getCredential()
Boolean	AwsComputeSource.getEnableDetailedMonitoring()
Boolean	AwsComputeSource.getEnableInstanceMetadataTags()
String	AzureComputeSource.getEnvironment()	Allows the specification of an Azure environment other than the default public environment.
@Valid AwsPlacementGroup	AwsComputeSource.getExistingPlacementGroup()
@Min(0L) Float	OciComputeSource.getFlexOcpus()	The number of OCPUs to provision on a flex type machine shape
@Min(0L) Float	OciComputeSource.getFlexRam()	The amount of ram in GB to provision on a flex type machine shape
GceHostMaintenanceBehaviour	GceComputeSource.getHostMaintenanceBehaviour()
String	AwsComputeSource.getIamInstanceProfileArn()
@NotBlank String	GceComputeSource.getImage()
@NotBlank String	ComputeSource.getImageId()	Gets the image ID to use for the instances that will be provisioned.
@Size(max=5) Map<String,String>	ComputeSource.getInstanceTags()	Gets the custom instance tags to be set on the provisioned instance at startup.
@NotBlank String	ComputeSource.getInstanceType()	Gets the provider-specific instance type of the instances that will be provisioned.
String	AwsComputeSource.getKeyName()
@Min(0L) int	ComputeSource.getLimit()	Returns the limit in number of instances that can be provisioned from this source.
@NotBlank String	GceComputeSource.getMachineType()
@Name @NotBlank @Pattern(regexp="[a-z](?:[a-z\\d_-]{0,58}[a-z\\d])?") @Size(max=60) String	ComputeSource.getName()	Returns the name of this compute source (which must be unique within the containing ComputeRequirement).
String	GceComputeSource.getNetwork()
@NotBlank String	AzureComputeSource.getNetworkName()
@NotBlank String	AzureComputeSource.getNetworkResourceGroupName()
@NotBlank String	GceComputeSource.getProject()
@NotBlank String	ComputeSource.getRegion()	Gets the provider-specific region where instances will be provisioned.
@Size(max=31) List<AwsSecondaryNetworkInterface>	AwsComputeSource.getSecondaryNetworkInterfaces()
@NotBlank String	AwsComputeSource.getSecurityGroupId()
@NotBlank String	OciComputeSource.getShape()	The machine shape to use for the provisioned instances.
@DecimalMin("0.00001") Double	AzureComputeSource.getSpotMaxPrice()	The maximum price that will be paid for Spot VMs provisioned from this source.
String	AzureComputeSource.getSshKey()
String	OciComputeSource.getSshKey()	The public SSH key.
String	GceComputeSource.getSshKeys()
String	AwsComputeSource.getSubnetId()
@NotBlank String	OciComputeSource.getSubnetId()	The region-specific OCI Subnet ID (ocid) for the subnet to use for the provisioned instances.
@NotBlank String	AzureComputeSource.getSubnetName()
String	GceComputeSource.getSubnetwork()
String	ComputeSource.getSubregion()	Gets the provider-specific subregion (aka Availability Domain, Availability Zone or Zone) where instances will be provisioned.
Boolean	AzureComputeSource.getUseAcceleratedNetworking()
String	ComputeSource.getUserData()	Gets the user-data script to be passed to the provisioned instance at startup.
Boolean	AzureComputeSource.getUseSpot()	Indicates if Spot VMs should be requested from Azure.
@NotBlank String	AzureComputeSource.getVmSize()
String	GceComputeSource.getZone()
boolean	AwsComputeSource.isAssignPublicIp()
boolean	AzureComputeSource.isAssignPublicIp()
boolean	GceComputeSource.isAssignPublicIp()
boolean	OciComputeSource.isAssignPublicIp()
boolean	GceComputeSource.isConfidential()
boolean	GceComputeSource.isPreemptible()
boolean	GceComputeSource.isSpot()