The identity and technical contract details declared by the specification.
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.AccountReference
object
AccountReference is a reference to a user account in another system that is attached to this user
2 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.App
object
App is the metadata for an App
4 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.AppList
object
AppList is a structure used by k8s to store lists of apps
4 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.AppSpec
object
AppSpec provides details of the metadata for an App
3 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Approve
object
Approve specifies a configuration for a single approve. The configuration for the approve plugin is defined as a list of these structures.
4 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Attachment
object
2 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.BatchPipelineActivity
object
BatchPipelineActivity contains information about a batch build, used by both the batch build and its comprising PRs for linking them together
3 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Binary
object
Binary provies the details of a downloadable binary
3 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.BranchProtectionContextPolicy
object
BranchProtectionContextPolicy configures required git provider contexts. Strict determines whether merging to the branch invalidates existing contexts.
2 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Brancher
object
Brancher is for shared code between jobs that only run against certain branches. An empty brancher runs against all branches.
2 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.BuildPack
object
BuildPack represents a set of language specific build packs and associated quickstarts
4 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.BuildPackList
object
BuildPackList is a list of TypeMeta resources
4 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.BuildPackSpec
object
BuildPackSpec is the specification of an BuildPack
4 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ChartRef
object
3 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CommitStatus
object
CommitStatus represents the commit statuses for a particular pull request
4 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CommitStatusCommitReference
object
3 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CommitStatusDetails
object
5 properties
4 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CommitStatusItem
object
3 properties
1 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CommitStatusList
object
CommitStatusList is a structure used by k8s to store lists of commit statuses
4 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CommitStatusSpec
object
CommitStatusSpec provides details of a particular commit status
1 property
1 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CommitSummary
object
CommitSummary is the summary of a commit
7 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ConfigMapSpec
object
ConfigMapSpec contains configuration options for the configMap being updated by the config-updater plugin.
4 properties
1 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ConfigUpdater
object
ConfigUpdater holds configuration for the config updater plugin
4 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ContextPolicy
object
ContextPolicy configures options about how to handle various contexts.
5 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CoreActivityStep
object
CoreActivityStep is a base step included in Stages of a pipeline or other kinds of step
5 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.DependencyUpdate
object
DependencyUpdate describes an dependency update message from the commit log
12 properties
11 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.DependencyUpdateDetails
object
DependencyUpdateDetails are the details of a dependency update
11 properties
11 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.DeployOptions
object
DeployOptions configures options for how to deploy applications by default such as using progressive delivery or using horizontal pod autoscaler
2 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Environment
object
Environment represents an environment like Dev, Test, Staging, Production where code lives
5 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentFilter
object
EnvironmentFilter specifies the environments to apply the role binding to
3 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentList
object
EnvironmentList is a list of TypeMeta resources
4 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentRepository
object
EnvironmentRepository is the repository for an environment using GitOps
3 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentRoleBinding
object
EnvironmentRoleBinding is like a vanilla RoleBinding but applies to a set of Namespaces based on an Environment filter so that roles can be bound to multiple n…
5 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentRoleBindingList
object
EnvironmentRoleBindingList is a list of TypeMeta resources
4 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentRoleBindingSpec
object
EnvironmentRoleBindingSpec is the specification of an EnvironmentRoleBinding
3 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentRoleBindingStatus
object
EnvironmentRoleBindingStatus is the status for an EnvironmentRoleBinding resource
1 property
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentSpec
object
EnvironmentSpec is the specification of an Environment
12 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentStatus
object
EnvironmentStatus is the status for an Environment resource
1 property
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentVariable
object
2 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Extension
object
Extension represents an extension available to this Jenkins X install
4 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionConfig
object
ExtensionConfig is the configuration and enablement for an extension inside an app
3 properties
3 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionConfigList
object
ExtensionsConfigList contains a list of ExtensionConfig items
1 property
1 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionDefinition
object
ExtensionDefinition defines an Extension
9 properties
3 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionDefinitionChildReference
object
ExtensionDefinitionChildReference provides a reference to a child
5 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionDefinitionList
object
ExtensionDefinitionList contains a list of ExtensionDefinition items
2 properties
1 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionDefinitionReference
object
ExtensionRepositoryReference references a GitHub repo that contains extension definitions
2 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionDefinitionReferenceList
object
ExtensionDefinitionReferenceList contains a list of ExtensionRepository items
1 property
1 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionExecution
object
ExtensionExecution is an executable instance of an extension which can be attached into a pipeline for later execution. It differs from an Extension as it cann…
7 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionList
object
ExtensionList is a list of Extensions available for a team
4 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionParameter
object
ExtensionParameter describes a parameter definition for an extension
4 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionParameterValue
object
2 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionRepositoryReference
object
3 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionRepositoryReferenceList
object
1 property
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionSpec
object
ExtensionSpec provides details of an extension available for a team
10 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExternalPlugin
object
ExternalPlugin holds configuration for registering an external plugin.
3 properties
1 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Fact
object
Fact represents observed facts. Apps will generate Facts about the system. A naming schema is required since each Fact has a name that's unique for the whole s…
5 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.FactList
object
FactList is a list of Fact resources
4 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.FactSpec
object
FactSpec is the specification of a Fact
7 properties
3 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.FactStatus
object
FactStatus is the status for an Fact resource
1 property
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.GitService
object
GitService represents a git provider so we can map the host name to a kinda of git service
4 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.GitServiceList
object
GitServiceList is a list of GitService resources
4 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.GitServiceSpec
object
GitServiceSpec is the specification of an GitService
3 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.GitStatus
object
GitStatus the status of a git commit in terms of CI/CD
2 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.GlobalProtectionPolicy
object
GlobalProtectionPolicy defines the default branch protection policy for the scheduler
2 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.IssueLabel
object
3 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.IssueSummary
object
IssueSummary is the summary of an issue
11 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.JobBase
object
JobBase contains attributes common to all job types
7 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Lgtm
object
Lgtm specifies a configuration for a single lgtm. The configuration for the lgtm plugin is defined as a list of these structures.
3 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Measurement
object
Measurement is a percentage or a count, something measured that the system will capture within a fact
4 properties
3 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Merger
object
Merger defines the options used to merge the PR
7 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Original
object
Original contains the report
3 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Periodic
object
Periodic defines a job to be run periodically
4 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Periodics
object
Periodics is a list of jobs to be run periodically
2 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineActivity
object
PipelineActivity represents pipeline activity for a particular run of a pipeline
5 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineActivityList
object
PipelineActivityList is a list of PipelineActivity resources
4 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineActivitySpec
object
PipelineActivitySpec is the specification of the pipeline activity
29 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineActivityStatus
object
PipelineActivityStatus is the status for an Environment resource
1 property
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineActivityStep
object
PipelineActivityStep represents a step in a pipeline activity
4 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineExtension
object
PipelineExtension defines the image and command of an app which wants to modify/extend the pipeline
4 properties
1 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineStructure
object
PipelineStructure contains references to the Pipeline and PipelineRun, and a list of PipelineStructureStages in the pipeline. This allows us to map between a r…
6 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineStructureList
object
PipelineStructureList is a list of PipelineStructureList resources
4 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineStructureStage
object
PipelineStructureStage contains the stage's name, one of either a reference to the Task corresponding to the stage if it has steps, a list of sequential stage…
9 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Plugin
object
Plugin represents a binary plugin installed into this Jenkins X team
4 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PluginList
object
PluginList is a list of Plugins available for a team
4 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PluginSpec
object
PluginSpec provides details of a binary plugin available for a team
6 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Postsubmit
object
Postsubmit runs on push events.
5 properties
1 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Postsubmits
object
Postsubmits is a list of Postsubmit job configurations that can optionally completely replace the Postsubmit job configurations in the parent scheduler
2 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Presubmit
object
Presubmit defines a job configuration for pull requests
13 properties
4 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Presubmits
object
Presubmits is a list of Presubmit job configurations that can optionally completely replace the Presubmit job configurations in the parent scheduler
2 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PreviewActivityStep
object
PreviewActivityStep is the step of creating a preview environment as part of a Pull Request pipeline
8 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PreviewGitSpec
object
PreviewGitSpec is the preview git branch/pull request details
9 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PromoteActivityStep
object
PromoteActivityStep is the step of promoting a version of an application to an environment
9 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PromotePullRequestStep
object
PromotePullRequestStep is the step for promoting a version to an environment by raising a Pull Request on the git repository of the environment
7 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PromoteUpdateStep
object
PromoteUpdateStep is the step for updating a promotion after the Pull Request merges to master
6 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PromoteWorkflowStep
object
PromoteWorkflowStep is the step of promoting a version of an application to an environment
1 property
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ProtectionPolicies
object
ProtectionPolicies defines the branch protection policies
3 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ProtectionPolicy
object
ProtectionPolicy for merging.
5 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PullRequestInfo
object
PullRequestInfo contains information about a PR included in a batch, like its PR number, the last build number, and SHA
3 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Query
object
Query is turned into a Git Provider search query. See the docs for details: https://help.github.com/articles/searching-issues-and-pull-requests/
6 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.QuickStartLocation
object
QuickStartLocation
5 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.RegexpChangeMatcher
object
RegexpChangeMatcher is for code shared between jobs that run only when certain files are changed.
1 property
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Release
object
Release represents a single version of an app that has been released
5 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReleaseList
object
ReleaseList is a list of Release resources
4 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReleaseSpec
object
ReleaseSpec is the specification of the Release
11 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReleaseStatus
object
ReleaseStatus is the status of a release
1 property
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableMapOfStringContextPolicy
object
ReplaceableMapOfStringContextPolicy is a map of context policies that can optionally completely replace any context policies defined in the parent scheduler
2 properties
1 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableMapOfStringString
object
ReplaceableMapOfStringString is a map of strings that can optionally completely replace the map of strings in the parent scheduler
2 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableSliceOfExternalPlugins
object
ReplaceableSliceOfExternalPlugins is a list of external plugins that can optionally completely replace the plugins in any parent SchedulerSpec
2 properties
1 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableSliceOfStrings
object
ReplaceableSliceOfStrings is a slice of strings that can optionally completely replace the slice of strings defined in the parent scheduler
2 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.RepoContextPolicy
object
RepoContextPolicy overrides the policy for repo, and any branch overrides.
2 properties
1 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ResourceReference
object
4 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Restrictions
object
Restrictions limits who can merge Users and Teams entries are appended to parent lists.
2 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReviewPolicy
object
ReviewPolicy specifies git provider approval/review criteria. Any nil values inherit the policy from the parent, otherwise bool/ints are overridden. Non-empty…
4 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Scheduler
object
Scheduler is configuration for a pipeline scheduler
4 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SchedulerAgent
object
SchedulerAgent defines the scheduler agent configuration
1 property
1 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SchedulerList
object
SchedulerList is a list of configurations for a pipeline scheduler
4 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SchedulerSpec
object
SchedulerSpec defines the pipeline scheduler (e.g. Prow) configuration
14 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SourceRepository
object
SourceRepository is the metadata for an Application/Project/SourceRepository
4 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SourceRepositoryGroup
object
SourceRepositoryGroup is the metadata for an Application/Project/SourceRepository
4 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SourceRepositoryGroupList
object
SourceRepositoryGroupList is a structure used by k8s to store lists of apps
4 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SourceRepositoryGroupSpec
object
SourceRepositoryGroupSpec is the metadata for an Application/Project/SourceRepository
5 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SourceRepositoryList
object
SourceRepositoryList is a structure used by k8s to store lists of apps
4 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SourceRepositorySpec
object
SourceRepositorySpec provides details of the metadata for an App
10 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.StageActivityStep
object
StageActivityStep represents a stage of zero to more sub steps in a jenkins pipeline
6 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Statement
object
Statement represents a decision that was made, for example that a promotion was approved or denied
4 properties
3 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.StorageLocation
object
StorageLocation
4 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Team
object
Team represents a request to create an actual Team which is a group of users, a development environment and optional other environments
5 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.TeamList
object
TeamList is a list of TypeMeta resources
4 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.TeamSettings
object
TeamSettings the default settings for a team
34 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.TeamSpec
object
TeamSpec is the specification of an Team
3 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.TeamStatus
object
TeamStatus is the status for an Team resource
2 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Trigger
object
Trigger specifies a configuration for a single trigger. The configuration for the trigger plugin is defined as a list of these structures.
4 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.User
object
User represents a git user so we have a cache to find by email address
5 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.UserDetails
object
UserDetails containers details of a user
9 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.UserList
object
UserList is a list of User resources
4 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.UserSpec
object
UserSpec is the user details
4 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Welcome
object
Welcome welcome plugin config
1 property
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Workflow
object
Workflow represents pipeline activity for a particular run of a pipeline
5 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.WorkflowList
object
WorkflowList is a list of Workflow resources
4 properties
2 required
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.WorkflowPreconditions
object
WorkflowPreconditions is the trigger to start a step
1 property
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.WorkflowSpec
object
WorkflowSpec is the specification of the pipeline activity
2 properties
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.WorkflowStatus
object
WorkflowStatus is the status for an Environment resource
1 property
com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.WorkflowStep
object
WorkflowStep represents a step in a pipeline activity
5 properties
io.k8s.api.batch.v1.Job
object
Job represents the configuration of a single job.
5 properties
io.k8s.api.batch.v1.JobCondition
object
JobCondition describes current state of a job.
6 properties
2 required
io.k8s.api.batch.v1.JobSpec
object
JobSpec describes how the job execution will look like.
8 properties
1 required
io.k8s.api.batch.v1.JobStatus
object
JobStatus represents the current state of a Job.
6 properties
io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource
object
Represents a Persistent Disk resource in AWS. An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kube…
4 properties
1 required
io.k8s.api.core.v1.Affinity
object
Affinity is a group of affinity scheduling rules.
3 properties
io.k8s.api.core.v1.AzureDiskVolumeSource
object
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
6 properties
2 required
io.k8s.api.core.v1.AzureFileVolumeSource
object
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
3 properties
2 required
io.k8s.api.core.v1.CSIVolumeSource
object
Represents a source location of a volume to mount, managed by an external CSI driver
5 properties
1 required
io.k8s.api.core.v1.Capabilities
object
Adds and removes POSIX capabilities from running containers.
2 properties
io.k8s.api.core.v1.CephFSVolumeSource
object
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
6 properties
1 required
io.k8s.api.core.v1.CinderVolumeSource
object
Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the…
4 properties
1 required
io.k8s.api.core.v1.ConfigMapEnvSource
object
ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-val…
2 properties
io.k8s.api.core.v1.ConfigMapKeySelector
object
Selects a key from a ConfigMap.
3 properties
1 required
io.k8s.api.core.v1.ConfigMapProjection
object
Adapts a ConfigMap into a projected volume. The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys i…
3 properties
io.k8s.api.core.v1.ConfigMapVolumeSource
object
Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as…
4 properties
io.k8s.api.core.v1.Container
object
A single application container that you want to run within a pod.
22 properties
1 required
io.k8s.api.core.v1.ContainerPort
object
ContainerPort represents a network port in a single container.
5 properties
1 required
io.k8s.api.core.v1.DownwardAPIProjection
object
Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.
1 property
io.k8s.api.core.v1.DownwardAPIVolumeFile
object
DownwardAPIVolumeFile represents information to create the file containing the pod field
4 properties
1 required
io.k8s.api.core.v1.DownwardAPIVolumeSource
object
DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.
2 properties
io.k8s.api.core.v1.EmptyDirVolumeSource
object
Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
2 properties
io.k8s.api.core.v1.EnvFromSource
object
EnvFromSource represents the source of a set of ConfigMaps
3 properties
io.k8s.api.core.v1.EnvVar
object
EnvVar represents an environment variable present in a Container.
3 properties
1 required
io.k8s.api.core.v1.EnvVarSource
object
EnvVarSource represents a source for the value of an EnvVar.
4 properties
io.k8s.api.core.v1.EphemeralContainer
object
An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers hav…
23 properties
1 required
io.k8s.api.core.v1.EphemeralVolumeSource
object
Represents an ephemeral volume that is handled by a normal storage driver.
2 properties
io.k8s.api.core.v1.ExecAction
object
ExecAction describes a "run in container" action.
1 property
io.k8s.api.core.v1.FCVolumeSource
object
Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux…
5 properties
io.k8s.api.core.v1.FlexVolumeSource
object
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
5 properties
1 required
io.k8s.api.core.v1.FlockerVolumeSource
object
Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownersh…
2 properties
io.k8s.api.core.v1.GCEPersistentDiskVolumeSource
object
Represents a Persistent Disk resource in Google Compute Engine. A GCE PD must exist before mounting to a container. The disk must also be in the same GCE proje…
4 properties
1 required
io.k8s.api.core.v1.GitRepoVolumeSource
object
Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SEL…
3 properties
1 required
io.k8s.api.core.v1.GlusterfsVolumeSource
object
Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.
3 properties
2 required
io.k8s.api.core.v1.HTTPGetAction
object
HTTPGetAction describes an action based on HTTP Get requests.
5 properties
1 required
io.k8s.api.core.v1.HTTPHeader
object
HTTPHeader describes a custom header to be used in HTTP probes
2 properties
2 required
io.k8s.api.core.v1.Handler
object
Handler defines a specific action that should be taken
3 properties
io.k8s.api.core.v1.HostAlias
object
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.
2 properties
io.k8s.api.core.v1.HostPathVolumeSource
object
Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.
2 properties
1 required
io.k8s.api.core.v1.ISCSIVolumeSource
object
Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
11 properties
3 required
io.k8s.api.core.v1.KeyToPath
object
Maps a string key to a path within a volume.
3 properties
2 required
io.k8s.api.core.v1.Lifecycle
object
Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers,…
2 properties
io.k8s.api.core.v1.LocalObjectReference
object
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
1 property
io.k8s.api.core.v1.NFSVolumeSource
object
Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.
3 properties
2 required
io.k8s.api.core.v1.NodeAffinity
object
Node affinity is a group of node affinity scheduling rules.
2 properties
io.k8s.api.core.v1.NodeSelector
object
A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represente…
1 property
1 required
io.k8s.api.core.v1.NodeSelectorRequirement
object
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
3 properties
2 required
io.k8s.api.core.v1.NodeSelectorTerm
object
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelecto…
2 properties
io.k8s.api.core.v1.ObjectFieldSelector
object
ObjectFieldSelector selects an APIVersioned field of an object.
2 properties
1 required
io.k8s.api.core.v1.PersistentVolumeClaimSpec
object
PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes
7 properties
io.k8s.api.core.v1.PersistentVolumeClaimTemplate
object
PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.
2 properties
1 required
io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource
object
PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A Persist…
2 properties
1 required
io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource
object
Represents a Photon Controller persistent disk resource.
2 properties
1 required
io.k8s.api.core.v1.PodAffinity
object
Pod affinity is a group of inter pod affinity scheduling rules.
2 properties
io.k8s.api.core.v1.PodAffinityTerm
object
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-loca…
3 properties
1 required
io.k8s.api.core.v1.PodAntiAffinity
object
Pod anti affinity is a group of inter pod anti affinity scheduling rules.
2 properties
io.k8s.api.core.v1.PodDNSConfig
object
PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
3 properties
io.k8s.api.core.v1.PodDNSConfigOption
object
PodDNSConfigOption defines DNS resolver options of a pod.
2 properties
io.k8s.api.core.v1.PodReadinessGate
object
PodReadinessGate contains the reference to a pod condition
1 property
1 required
io.k8s.api.core.v1.PodSecurityContext
object
PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values o…
10 properties
io.k8s.api.core.v1.PodSpec
object
PodSpec is a description of a pod.
35 properties
1 required
io.k8s.api.core.v1.PodTemplateSpec
object
PodTemplateSpec describes the data a pod should have when created from a template
2 properties
io.k8s.api.core.v1.PortworxVolumeSource
object
PortworxVolumeSource represents a Portworx volume resource.
3 properties
1 required
io.k8s.api.core.v1.PreferredSchedulingTerm
object
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is…
2 properties
2 required
io.k8s.api.core.v1.Probe
object
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
8 properties
io.k8s.api.core.v1.ProjectedVolumeSource
object
Represents a projected volume source
2 properties
io.k8s.api.core.v1.QuobyteVolumeSource
object
Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.
6 properties
2 required
io.k8s.api.core.v1.RBDVolumeSource
object
Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.
8 properties
2 required
io.k8s.api.core.v1.ResourceFieldSelector
object
ResourceFieldSelector represents container resources (cpu, memory) and their output format
3 properties
1 required
io.k8s.api.core.v1.ResourceRequirements
object
ResourceRequirements describes the compute resource requirements.
2 properties
io.k8s.api.core.v1.SELinuxOptions
object
SELinuxOptions are the labels to be applied to the container
4 properties
io.k8s.api.core.v1.ScaleIOVolumeSource
object
ScaleIOVolumeSource represents a persistent ScaleIO volume
10 properties
3 required
io.k8s.api.core.v1.SeccompProfile
object
SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.
2 properties
1 required
io.k8s.api.core.v1.SecretEnvSource
object
SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs…
2 properties
io.k8s.api.core.v1.SecretKeySelector
object
SecretKeySelector selects a key of a Secret.
3 properties
1 required
io.k8s.api.core.v1.SecretProjection
object
Adapts a secret into a projected volume. The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the…
3 properties
io.k8s.api.core.v1.SecretVolumeSource
object
Adapts a Secret into a volume. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the fi…
4 properties
io.k8s.api.core.v1.SecurityContext
object
SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When…
11 properties
io.k8s.api.core.v1.ServiceAccountTokenProjection
object
ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods…
3 properties
1 required
io.k8s.api.core.v1.StorageOSVolumeSource
object
Represents a StorageOS persistent volume resource.
5 properties
io.k8s.api.core.v1.Sysctl
object
Sysctl defines a kernel parameter to be set
2 properties
2 required
io.k8s.api.core.v1.TCPSocketAction
object
TCPSocketAction describes an action based on opening a socket
2 properties
1 required
io.k8s.api.core.v1.Toleration
object
The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .
5 properties
io.k8s.api.core.v1.TopologySpreadConstraint
object
TopologySpreadConstraint specifies how to spread matching pods among the given topology.
4 properties
3 required
io.k8s.api.core.v1.TypedLocalObjectReference
object
TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.
3 properties
2 required
io.k8s.api.core.v1.Volume
object
Volume represents a named volume in a pod that may be accessed by any container in the pod.
30 properties
1 required
io.k8s.api.core.v1.VolumeDevice
object
volumeDevice describes a mapping of a raw block device within a container.
2 properties
2 required
io.k8s.api.core.v1.VolumeMount
object
VolumeMount describes a mounting of a Volume within a container.
6 properties
2 required
io.k8s.api.core.v1.VolumeProjection
object
Projection that may be projected along with other supported volume types
4 properties
io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource
object
Represents a vSphere volume resource.
4 properties
1 required
io.k8s.api.core.v1.WeightedPodAffinityTerm
object
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
2 properties
2 required
io.k8s.api.core.v1.WindowsSecurityContextOptions
object
WindowsSecurityContextOptions contain Windows-specific options and credentials.
3 properties
io.k8s.api.rbac.v1.PolicyRule
object
PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies t…
5 properties
1 required
io.k8s.api.rbac.v1.Role
object
Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.
4 properties
io.k8s.api.rbac.v1.RoleRef
object
RoleRef contains information that points to the role being used
3 properties
3 required
io.k8s.api.rbac.v1.Subject
object
Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non…
4 properties
2 required
io.k8s.apimachinery.pkg.api.resource.Quantity
string
Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() ac…
io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1
object
FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to…
io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector
object
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all object…
2 properties
io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement
object
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
3 properties
2 required
io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta
object
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMe…
4 properties
io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry
object
ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.
6 properties
io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta
object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
16 properties
io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference
object
OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster…
6 properties
4 required
io.k8s.apimachinery.pkg.apis.meta.v1.Time
string
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time pack…
io.k8s.apimachinery.pkg.util.intstr.IntOrString
string
IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Continuous Delivery Foundation publishes across the network.