Skip to content
Ona API Reference
Ona Docs
API Reference
Runners

Configurations

ValidateRunnerConfiguration
client.Runners.Configurations.Validate(ctx, body) (*RunnerConfigurationValidateResponse, error)
POST/gitpod.v1.RunnerConfigurationService/ValidateRunnerConfiguration
ModelsExpand Collapse
type EnvironmentClassValidationResult struct{…}
ConfigurationErrors []FieldValidationErrorOptional
Error stringOptional
Key stringOptional
DescriptionError stringOptional
DisplayNameError stringOptional
Valid boolOptional
type FieldValidationError struct{…}
Error stringOptional
Key stringOptional
type ScmIntegrationValidationResult struct{…}
HostError stringOptional
OAuthError stringOptional
PatError stringOptional
ScmIDError stringOptional
Valid boolOptional

ConfigurationsEnvironment Classes

CreateEnvironmentClass
client.Runners.Configurations.EnvironmentClasses.New(ctx, body) (*RunnerConfigurationEnvironmentClassNewResponse, error)
POST/gitpod.v1.RunnerConfigurationService/CreateEnvironmentClass
ListEnvironmentClasses
client.Runners.Configurations.EnvironmentClasses.List(ctx, params) (*EnvironmentClassesPage[EnvironmentClass], error)
POST/gitpod.v1.RunnerConfigurationService/ListEnvironmentClasses
GetEnvironmentClass
client.Runners.Configurations.EnvironmentClasses.Get(ctx, body) (*RunnerConfigurationEnvironmentClassGetResponse, error)
POST/gitpod.v1.RunnerConfigurationService/GetEnvironmentClass
UpdateEnvironmentClass
client.Runners.Configurations.EnvironmentClasses.Update(ctx, body) (*RunnerConfigurationEnvironmentClassUpdateResponse, error)
POST/gitpod.v1.RunnerConfigurationService/UpdateEnvironmentClass

ConfigurationsHost Authentication Tokens

CreateHostAuthenticationToken
client.Runners.Configurations.HostAuthenticationTokens.New(ctx, body) (*RunnerConfigurationHostAuthenticationTokenNewResponse, error)
POST/gitpod.v1.RunnerConfigurationService/CreateHostAuthenticationToken
DeleteHostAuthenticationToken
client.Runners.Configurations.HostAuthenticationTokens.Delete(ctx, body) (*RunnerConfigurationHostAuthenticationTokenDeleteResponse, error)
POST/gitpod.v1.RunnerConfigurationService/DeleteHostAuthenticationToken
ListHostAuthenticationTokens
client.Runners.Configurations.HostAuthenticationTokens.List(ctx, params) (*TokensPage[HostAuthenticationToken], error)
POST/gitpod.v1.RunnerConfigurationService/ListHostAuthenticationTokens
GetHostAuthenticationToken
client.Runners.Configurations.HostAuthenticationTokens.Get(ctx, body) (*RunnerConfigurationHostAuthenticationTokenGetResponse, error)
POST/gitpod.v1.RunnerConfigurationService/GetHostAuthenticationToken
UpdateHostAuthenticationToken
client.Runners.Configurations.HostAuthenticationTokens.Update(ctx, body) (*RunnerConfigurationHostAuthenticationTokenUpdateResponse, error)
POST/gitpod.v1.RunnerConfigurationService/UpdateHostAuthenticationToken
ModelsExpand Collapse
type HostAuthenticationToken struct{…}
ID string
ExpiresAt TimeOptional

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are “smeared” so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

 Timestamp timestamp;
 timestamp.set_seconds(time(NULL));
 timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

 struct timeval tv;
 gettimeofday(&tv, NULL);

 Timestamp timestamp;
 timestamp.set_seconds(tv.tv_sec);
 timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

 FILETIME ft;
 GetSystemTimeAsFileTime(&ft);
 UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

 // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
 // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
 Timestamp timestamp;
 timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
 timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

 long millis = System.currentTimeMillis();

 Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
     .setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from Java Instant.now().

 Instant now = Instant.now();

 Timestamp timestamp =
     Timestamp.newBuilder().setSeconds(now.getEpochSecond())
         .setNanos(now.getNano()).build();

Example 6: Compute Timestamp from current time in Python.

 timestamp = Timestamp()
 timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is “{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z” where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The “Z” suffix indicates the timezone (“UTC”); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by “Z”) when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, “2017-01-15T01:30:15.01Z” encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec ‘%Y-%m-%dT%H:%M:%S.%fZ’. Likewise, in Java, one can use the Joda Time’s ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

formatdate-time
Host stringOptional
IntegrationID stringOptional

links to integration instance

RunnerID stringOptional
Scopes []stringOptional

token permissions

Source HostAuthenticationTokenSourceOptional

auth_type

One of the following:
const HostAuthenticationTokenSourceUnspecified HostAuthenticationTokenSource = "HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED"
const HostAuthenticationTokenSourceOAuth HostAuthenticationTokenSource = "HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH"
const HostAuthenticationTokenSourcePat HostAuthenticationTokenSource = "HOST_AUTHENTICATION_TOKEN_SOURCE_PAT"
Subject SubjectOptional

Subject identifies the principal (user or service account) for the token Note: actual token and refresh_token values are retrieved via GetHostAuthenticationTokenValue API

ID stringOptional

id is the UUID of the subject

formatuuid
Principal PrincipalOptional

Principal is the principal of the subject

One of the following:
const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"
const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"
const PrincipalUser Principal = "PRINCIPAL_USER"
const PrincipalRunner Principal = "PRINCIPAL_RUNNER"
const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"
const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"
const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"
DeprecatedUserID stringOptional

Deprecated: Use principal_id and principal_type instead principal (user)

type HostAuthenticationTokenSource string
One of the following:
const HostAuthenticationTokenSourceUnspecified HostAuthenticationTokenSource = "HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED"
const HostAuthenticationTokenSourceOAuth HostAuthenticationTokenSource = "HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH"
const HostAuthenticationTokenSourcePat HostAuthenticationTokenSource = "HOST_AUTHENTICATION_TOKEN_SOURCE_PAT"

ConfigurationsSchema

GetRunnerConfigurationSchema
client.Runners.Configurations.Schema.Get(ctx, body) (*RunnerConfigurationSchemaGetResponse, error)
POST/gitpod.v1.RunnerConfigurationService/GetRunnerConfigurationSchema
ModelsExpand Collapse
type RunnerConfigurationSchema struct{…}
EnvironmentClasses []RunnerConfigurationSchemaEnvironmentClassOptional
ID stringOptional
Bool RunnerConfigurationSchemaEnvironmentClassesBoolOptional
Default boolOptional
Description stringOptional
Display RunnerConfigurationSchemaEnvironmentClassesDisplayOptional
Default stringOptional
Enum RunnerConfigurationSchemaEnvironmentClassesEnumOptional
DeprecatedDefault stringOptional

deprecated, will be removed, use default_value instead

DefaultValue RunnerConfigurationSchemaEnvironmentClassesEnumDefaultValueOptional
Detail stringOptional
Subtitle stringOptional
Title stringOptional
PossibleValues []RunnerConfigurationSchemaEnvironmentClassesEnumPossibleValueOptional
Detail stringOptional
Subtitle stringOptional
Title stringOptional
DeprecatedValues []stringOptional

deprecated, will be removed, use possible_values instead

Int RunnerConfigurationSchemaEnvironmentClassesIntOptional
Default int64Optional
formatint32
Max int64Optional
formatint32
Min int64Optional
formatint32
Name stringOptional
Required boolOptional
Secret boolOptional
String RunnerConfigurationSchemaEnvironmentClassesStringOptional
Default stringOptional
Pattern stringOptional
RunnerConfig []RunnerConfigurationSchemaRunnerConfigOptional
ID stringOptional
Bool RunnerConfigurationSchemaRunnerConfigBoolOptional
Default boolOptional
Description stringOptional
Display RunnerConfigurationSchemaRunnerConfigDisplayOptional
Default stringOptional
Enum RunnerConfigurationSchemaRunnerConfigEnumOptional
DeprecatedDefault stringOptional

deprecated, will be removed, use default_value instead

DefaultValue RunnerConfigurationSchemaRunnerConfigEnumDefaultValueOptional
Detail stringOptional
Subtitle stringOptional
Title stringOptional
PossibleValues []RunnerConfigurationSchemaRunnerConfigEnumPossibleValueOptional
Detail stringOptional
Subtitle stringOptional
Title stringOptional
DeprecatedValues []stringOptional

deprecated, will be removed, use possible_values instead

Int RunnerConfigurationSchemaRunnerConfigIntOptional
Default int64Optional
formatint32
Max int64Optional
formatint32
Min int64Optional
formatint32
Name stringOptional
Required boolOptional
Secret boolOptional
String RunnerConfigurationSchemaRunnerConfigStringOptional
Default stringOptional
Pattern stringOptional
Scm []RunnerConfigurationSchemaScmOptional
DefaultHosts []stringOptional
Name stringOptional
OAuth RunnerConfigurationSchemaScmOAuthOptional
CallbackURL stringOptional

callback_url is the URL the OAuth app will redirect to after the user has authenticated.

Pat RunnerConfigurationSchemaScmPatOptional
Description stringOptional

description is a human-readable description of the PAT.

ScmID stringOptional
Version stringOptional

The schema version

ConfigurationsScm Integrations

CreateSCMIntegration
client.Runners.Configurations.ScmIntegrations.New(ctx, body) (*RunnerConfigurationScmIntegrationNewResponse, error)
POST/gitpod.v1.RunnerConfigurationService/CreateSCMIntegration
DeleteSCMIntegration
client.Runners.Configurations.ScmIntegrations.Delete(ctx, body) (*RunnerConfigurationScmIntegrationDeleteResponse, error)
POST/gitpod.v1.RunnerConfigurationService/DeleteSCMIntegration
ListSCMIntegrations
client.Runners.Configurations.ScmIntegrations.List(ctx, params) (*IntegrationsPage[ScmIntegration], error)
POST/gitpod.v1.RunnerConfigurationService/ListSCMIntegrations
GetSCMIntegration
client.Runners.Configurations.ScmIntegrations.Get(ctx, body) (*RunnerConfigurationScmIntegrationGetResponse, error)
POST/gitpod.v1.RunnerConfigurationService/GetSCMIntegration
UpdateSCMIntegration
client.Runners.Configurations.ScmIntegrations.Update(ctx, body) (*RunnerConfigurationScmIntegrationUpdateResponse, error)
POST/gitpod.v1.RunnerConfigurationService/UpdateSCMIntegration
ModelsExpand Collapse
type ScmIntegration struct{…}
ID stringOptional

id is the unique identifier of the SCM integration

Host stringOptional
ClientID stringOptional

client_id is the OAuth app’s client ID in clear text.

EncryptedClientSecret stringOptional

encrypted_client_secret is the OAuth app’s secret encrypted with the runner’s public key.

formatbyte
IssuerURL stringOptional

issuer_url is used to override the authentication provider URL, if it doesn’t match the SCM host.

+optional if not set, this account is owned by the installation.

Pat boolOptional
RunnerID stringOptional
ScmID stringOptional

scm_id references the scm_id in the runner’s configuration schema that this integration is for

VirtualDirectory stringOptional

virtual_directory is the virtual directory path for Azure DevOps Server (e.g., “/tfs”). This field is only used for Azure DevOps Server SCM integrations and should be empty for other SCM types. Azure DevOps Server APIs work without collection when PAT scope is ‘All accessible organizations’.

type ScmIntegrationOAuthConfig struct{…}
ClientID stringOptional

client_id is the OAuth app’s client ID in clear text.

EncryptedClientSecret stringOptional

encrypted_client_secret is the OAuth app’s secret encrypted with the runner’s public key.

formatbyte
IssuerURL stringOptional

issuer_url is used to override the authentication provider URL, if it doesn’t match the SCM host.

+optional if not set, this account is owned by the installation.