package model

Get desktop application:
View/edit binary Protocol Buffers messages

Message that tells how the user was authenticated.

oneof method
- LoginType login_type = 1

Author of a change.

Used in: api.v1.capsule.Capsule, api.v1.capsule.ConfigFile, api.v1.capsule.Event, api.v1.capsule.Image, api.v1.capsule.RolloutConfig, api.v1.service_account.ServiceAccount, ProposalMetadata, RevisionMetadata, ServiceAccountEntry

string identifier = 1
Cached identifier of the author, e.g. email or username at the time of change.
string printable_name = 2
Cached pretty-printed name of the author at the time of change.
oneof account
User ID of the author. This should be used to get current information about the author.
- string user_id = 3
  if a user did the change
- string service_account_id = 4
  if a service account did the change

Bcrypt hashing configuration.

Used in: HashingConfig

int32 cost = 1
The cost of the hashing algorithm.

Bcrypt hashing instance.

Used in: HashingInstance

(message has no fields)

Used in: Commit

string team = 1
string project = 2
string repository = 3

Used in: RevisionMetadata

bool dont_bookmark = 1

Used in: api.v1.settings.GetGitStoreStatusResponse.CapsuleStatus

string project = 1
string environment = 2
string capsule = 3

Used in: api.v1.settings.GetGitStoreStatusResponse.CapsuleSetStatus

string project = 1
string capsule = 2

Used in: GitChange

GitProvider provider = 1
oneof provider_info
- GitHubInfo github = 7
- GitLabInfo gitlab = 8
- BitBucketInfo bitbucket = 9
string commit_id = 3
string commit_url = 4
string repository_url = 6

Metrics for a container.

Used in: InstanceMetrics

optional google.protobuf.Timestamp timestamp = 1
Timestamp of the metrics.
uint64 memory_bytes = 2
Memory usage in bytes.
uint64 cpu_ms = 3
CPU usage in milliseconds.
uint64 storage_bytes = 4
Storage usage in bytes.

Used in: GitStore, NotificationNotifier

oneof filter
- EnvironmentFilter.All all = 1
- EnvironmentFilter.Selected selected = 2

Used in: EnvironmentFilter

bool include_ephemeral = 1

Used in: EnvironmentFilter

repeated string environment_ids = 1

Used in: Phase

bool inclusion = 1
If true, only fields with the specified prefixes will be promoted If false, only fields without the specified prefixes will be promoted
repeated string prefixes = 2

Used in: api.v1.capsule.DeployRequest, api.v1.capsule.DeploySetRequest, api.v1.capsule.GetRevisionRequest, Fingerprints, ProposalMetadata, RevisionMetadata

string data = 1

Used in: api.v1.capsule.GetRolloutOfRevisionsRequest

optional Fingerprint project = 1
optional Fingerprint environment = 2
optional Fingerprint capsule_set = 3
optional Fingerprint capsule = 4

Used in: RevisionMetadata

optional Commit commit = 1
repeated string paths = 2

Used in: Commit

string owner = 1
string repository = 2

Used in: Commit

repeated string groups = 1
string project = 2

Used in: ProposalMetadata

int64 pr_id = 1

Used in: Commit

GIT_PROVIDER_UNSPECIFIED = 0
GIT_PROVIDER_GITHUB = 1
GIT_PROVIDER_GITLAB = 2
GIT_PROVIDER_BITBUCKET = 3

Used in: api.v1.settings.GetGitStoreStatusResponse.CapsuleSetStatus, api.v1.settings.GetGitStoreStatusResponse.CapsuleStatus, api.v1.settings.GetGitStoreStatusResponse.RepoGitStatus

string last_processed_commit_id = 1
optional google.protobuf.Timestamp last_processed_commit_time = 2
string last_successful_commit_id = 3
optional google.protobuf.Timestamp last_successful_commit_time = 4
string error = 5

Used in: api.v1.capsule.Capsule, api.v1.capsule.GetEffectiveGitSettingsResponse, api.v1.capsule.Update, api.v1.project.GetEffectiveGitSettingsResponse, api.v1.project.Project, api.v1.project.Update, api.v1.settings.Settings, api.v1.settings.Update

bool disabled = 1
string repository = 2
string branch = 3
string capsule_path = 4
string capsule_set_path = 10
string commit_template = 5
optional EnvironmentFilter environments = 6
string pr_title_template = 7
string pr_body_template = 8
bool require_pull_request = 9

Used in: ProposalMetadata

int64 pr_id = 1

Hashing configuration.

Used in: api.v1.user.settings.Settings, api.v1.user.settings.Update, HashingInstance

oneof method
- BcryptHashingConfig bcrypt = 1
  if bcrypt is set, use bcrypt.
- ScryptHashingConfig scrypt = 2
  if scrypt is set, use scrypt.

Hashing instance.

Used in: api.v1.user.Update, api.v1.user.VerificationCode

optional HashingConfig config = 1
The hashing configuration.
bytes hash = 2
A hash
oneof instance
- BcryptHashingInstance bcrypt = 3
  if bcrypt is set, this bcrypt instance was used.
- ScryptHashingInstance scrypt = 4
  if scrypt is set, this scrypt instance was used.

Metrics for an instance

Used in: api.v1.capsule.CapsuleMetricsResponse

string capsule_id = 1
Capsule of the instance.
string instance_id = 2
Instance ID.
optional ContainerMetrics main_container = 3
Main container metrics.
optional ContainerMetrics proxy_container = 4
Proxy container metrics.

The LoginType enum defines the type of login.

Used in: api.v1.authentication.GetAuthConfigResponse, api.v1.user.AuthMethod, api.v1.user.settings.AuthMethod, api.v1.user.settings.RegisterMethod.Signup, api.v1.user.settings.Settings, api.v1.user.settings.Update.LoginMechanisms, AuthMethod, RegisterMethod.Signup

LOGIN_TYPE_UNSPECIFIED = 0
Default value.
LOGIN_TYPE_EMAIL_PASSWORD = 1
Email and password login.
LOGIN_TYPE_PHONE_PASSWORD = 2
deprecated: text is not supported - Phone number and password login.
LOGIN_TYPE_USERNAME_PASSWORD = 3
Username and password login.
LOGIN_TYPE_SSO = 4
SSO Login

Entry model of a group member - placed in models to prevent cyclic imports.

Used in: api.v1.group.ListMembersResponse

oneof entry
The user or service account.
- UserEntry user = 1
  if the member is a user.
- ServiceAccountEntry service_account = 2
  if the member is a service account.
optional google.protobuf.Timestamp joined_at = 5
when the member joined the group.

Generic metadata model.

Used in: api.v1.group.Update, api.v1.role.Update, api.v1.user.Update

string key = 1
Key of the metadata.
bytes value = 2
Value of the metadata.

Custom metrics

Used in: api.v1.capsule.GetCustomInstanceMetricsResponse, api.v1.project.GetCustomObjectMetricsResponse

string name = 1
Name of the metric.
double latest_value = 2
Latest value of the metric.
optional google.protobuf.Timestamp latest_timestamp = 3
Timestamp of the latest value.

Used in: api.v1.project.GetEffectiveNotificationSettingsResponse, api.v1.project.NotificationNotifiers, api.v1.settings.Settings, api.v1.settings.Update.SetNotificationNotifiers

optional NotificationTarget target = 1
repeated NotificationTopic topics = 2
optional EnvironmentFilter environments = 3

Used in: NotificationNotifier

oneof target
- NotificationTarget.SlackTarget slack = 1
- NotificationTarget.EmailTarget email = 2

Used in: NotificationTarget

string id = 1
string from_email = 2
repeated string to_emails = 3

Used in: NotificationTarget

string workspace = 1
string channel_id = 2

Used in: NotificationNotifier

NOTIFICATION_TOPIC_UNSPECIFIED = 0
NOTIFICATION_TOPIC_ROLLOUT = 1
NOTIFICATION_TOPIC_ISSUE = 2
NOTIFICATION_TOPIC_PROJECT = 3
NOTIFICATION_TOPIC_ENVIRONMENT = 4
NOTIFICATION_TOPIC_CAPSULE = 5
NOTIFICATION_TOPIC_USER = 6

A reference to a kubernetes object.

Used in: api.v1.capsule.ObjectMetric, api.v1.project.GetCustomObjectMetricsRequest

string kind = 1
Type of object.
string name = 2
Name of the object.
string api_version = 3
Api version of the object.

Pagination option.

uint32 offset = 1
Where to start the pagination.
uint32 limit = 2
How many items to return.
bool descending = 3
Whether to sort in descending order.

Used in: Pipeline

string environment_id = 1
Environment to promote to. The project must be active in this environment.
optional FieldPrefixes field_prefixes = 2
Fields prefixes to either promote or not.
optional Triggers triggers = 3
Promotion triggers.

Used in: api.v1.capsule.pipeline.Status, api.v1.project.GetEffectivePipelineSettingsResponse.Pipeline, api.v1.project.Project, api.v1.project.Update.Pipelines, api.v1.settings.Settings, api.v1.settings.Update.SetPipelines

string name = 1
Custom name for the pipeline.
string initial_environment = 2
The environment to base the pipeline on.
repeated Phase phases = 3
The subsequent phases of the pipeline to promote to.
optional google.protobuf.Timestamp created_at = 4
The time the pipeline was created.
optional google.protobuf.Timestamp updated_at = 5
The time the pipeline was updated.
string description = 6
User specified description of the pipeline.

Used in: api.v1.capsule.Proposal, api.v1.capsule.SetProposal

optional google.protobuf.Timestamp created_at = 1
optional Author created_by = 2
optional Fingerprint fingerprint = 3
optional RepoBranch spawn_point = 4
string branch = 5
string review_url = 6
oneof provider
- GithubProposal github = 7
- GitLabProposal gitlab = 8

Generic credentials model.

Used in: api.v1.user.settings.EmailProvider, api.v1.user.settings.TextProvider

string public_key = 1
Public key.
string private_key = 2
Private key.

Registering information of a user.

Used in: api.v1.user.User, UserEntry

string creater_id = 1
Who created the user.
optional RegisterMethod method = 2
How the user was registered.

Method used to register a user.

Used in: RegisterInfo

oneof method
- RegisterMethod.System system = 1
  system created the user.
- RegisterMethod.Signup signup = 2
  user signed up.

if the user was created by signing up.

Used in: RegisterMethod

LoginType login_type = 1
The login type used to sign up.

if the user was created by the system.

Used in: RegisterMethod

(message has no fields)

Used in: api.v1.settings.GetGitStoreStatusResponse.RepoGitStatus, ProposalMetadata

string repository = 1
string branch = 2

Used in: api.v1.cluster.Cluster, api.v1.operator.cluster.Node, api.v1.operator.cluster.Pod

uint64 cpu_millis = 1
uint64 memory_bytes = 2
uint64 pods = 3

Used in: api.v1.capsule.Revision, api.v1.capsule.SetRevision, api.v1.environment.Revision, api.v1.project.Revision, Revisions

optional google.protobuf.Timestamp created_at = 1
optional google.protobuf.Timestamp updated_at = 2
optional Author updated_by = 3
optional Fingerprint fingerprint = 4
optional GitChange git_change = 5
optional BookmarkingConfiguration bookmarking = 6

Used in: api.v1.capsule.Rollout

repeated RevisionMetadata projects = 5
repeated RevisionMetadata environments = 6
repeated RevisionMetadata capsule_sets = 7
repeated RevisionMetadata capsules = 8

Scrypt hashing configuration.

Used in: HashingConfig

string signer_key = 1
The key used to sign the salt.
string salt_separator = 2
The salt separator.
int32 rounds = 3
The number of rounds in the algorithm.
int32 mem_cost = 4
The memory cost of the algorithm.
int32 p = 5
The parallelization factor of the algorithm.
int32 key_len = 6
The length of the key.

Scrypt hashing instance.

Used in: HashingInstance

bytes salt = 1
The salt used to hash the password.

Entry model of a service account - placed in models to prevent cyclic imports.

Used in: api.v1.service_account.ListResponse, MemberEntry

string service_account_id = 1
unique id of the service account.
string name = 2
name of the service account.
string client_id = 3
client id of the service account.
repeated string group_ids = 4
groups the service account belongs to.
optional google.protobuf.Timestamp created_at = 5
when the service account was created.
optional Author created_by = 6
who created the service account.

Used in: Triggers

repeated Trigger.Condition conditions = 1
The conditions that must be met for the trigger to fire.
bool require_all = 2
If true, all conditions must be met for the trigger to fire. Otherwise only a single condition must be met.
bool enabled = 3
If true, the trigger is enabled. Otherwise it is disabled.

Condition that must be met for the trigger to fire.

Used in: Trigger

oneof Condition
- google.protobuf.Duration time_alive = 1

Used in: Phase

optional Trigger automatic = 1
The automatic trigger
optional Trigger manual = 2
The manual trigger

Entry model of a user - placed in models to prevent cyclic imports.

Used in: api.v1.user.ListResponse, MemberEntry

string user_id = 1
unique id of the user.
string printable_name = 2
pretty printable name of a user.
optional RegisterInfo register_info = 3
how the user was registered.
bool verified = 4
whether the user is verified.
repeated string group_ids = 5
groups the user belongs to.
optional google.protobuf.Timestamp created_at = 6
when the user was created.

different fields that can identify a user.

Used in: api.v1.authentication.ResetPasswordRequest, api.v1.authentication.SendPasswordResetRequest, api.v1.authentication.SendVerificationEmailRequest, api.v1.authentication.UserPassword, api.v1.user.GetByIdentifierRequest

oneof identifier
- string username = 1
  username is unique.
- string email = 2
  email is unique.
- string phone_number = 3
  Deprecated: text is not supported - phone number is unique.

Userinfo - placed in models to prevent cyclic imports.

Used in: api.v1.authentication.GetResponse, api.v1.authentication.LoginResponse, api.v1.authentication.RegisterResponse, api.v1.user.User

string email = 1
email of the user.
string username = 2
username of the user.
string phone_number = 3
Deprecated: text is not supported - phone number of the user.
optional google.protobuf.Timestamp created_at = 5
when the user was created.
repeated string group_ids = 6
groups the user belongs to.

package model

message AuthMethod

oneof method

LoginType login_type = 1

message Author

string identifier = 1

string printable_name = 2

oneof account

string user_id = 3

string service_account_id = 4

message BcryptHashingConfig

int32 cost = 1

message BcryptHashingInstance

message BitBucketInfo

string team = 1

string project = 2

string repository = 3

message BookmarkingConfiguration

bool dont_bookmark = 1

message CapsuleID

string project = 1

string environment = 2

string capsule = 3

message CapsuleSetID

string project = 1

string capsule = 2

message Commit

GitProvider provider = 1

oneof provider_info

GitHubInfo github = 7

GitLabInfo gitlab = 8

BitBucketInfo bitbucket = 9

string commit_id = 3

string commit_url = 4

string repository_url = 6

message ContainerMetrics

optional google.protobuf.Timestamp timestamp = 1

uint64 memory_bytes = 2

uint64 cpu_ms = 3

uint64 storage_bytes = 4

message EnvironmentFilter

oneof filter

EnvironmentFilter.All all = 1

EnvironmentFilter.Selected selected = 2

message EnvironmentFilter.All

bool include_ephemeral = 1

message EnvironmentFilter.Selected

repeated string environment_ids = 1

message FieldPrefixes

bool inclusion = 1

repeated string prefixes = 2

message Fingerprint

string data = 1

message Fingerprints

optional Fingerprint project = 1

optional Fingerprint environment = 2

optional Fingerprint capsule_set = 3

optional Fingerprint capsule = 4

message GitChange

optional Commit commit = 1

repeated string paths = 2

message GitHubInfo

string owner = 1

string repository = 2

message GitLabInfo

repeated string groups = 1

string project = 2

message GitLabProposal

int64 pr_id = 1

enum GitProvider

GIT_PROVIDER_UNSPECIFIED = 0

GIT_PROVIDER_GITHUB = 1

GIT_PROVIDER_GITLAB = 2

GIT_PROVIDER_BITBUCKET = 3

message GitStatus

string last_processed_commit_id = 1

optional google.protobuf.Timestamp last_processed_commit_time = 2

string last_successful_commit_id = 3

optional google.protobuf.Timestamp last_successful_commit_time = 4

string error = 5