common.proto

flyteidl.admin.NamedEntityIdentifier

[flyteidl.admin.NamedEntityIdentifier proto]

Encapsulation of fields that identifies a Flyte resource. A resource can internally have multiple versions.

{
  "project": "...",
  "domain": "...",
  "name": "..."
}
project

(string) Name of the project the resource belongs to.

domain

(string) Name of the domain the resource belongs to. A domain can be considered as a subset within a specific project.

name

(string) User provided value for the resource. The combination of project + domain + name uniquely identifies the resource. +optional - in certain contexts - like ‘List API’, ‘Launch plans’

flyteidl.admin.NamedEntityMetadata

[flyteidl.admin.NamedEntityMetadata proto]

{
  "description": "..."
}
description

(string) Common description across all versions of the entity +optional

flyteidl.admin.NamedEntity

[flyteidl.admin.NamedEntity proto]

Describes information common to a NamedEntity, identified by a project / domain / name / resource type combination

{
  "resource_type": "...",
  "id": "{...}",
  "metadata": "{...}"
}
resource_type

(flyteidl.core.ResourceType)

id

(flyteidl.admin.NamedEntityIdentifier)

metadata

(flyteidl.admin.NamedEntityMetadata)

flyteidl.admin.Sort

[flyteidl.admin.Sort proto]

Species sort ordering in a list request.

{
  "key": "...",
  "direction": "..."
}
key

(string) Indicates an attribute to sort the response values. TODO(katrogan): Add string validation here. This should never be empty.

direction

(flyteidl.admin.Sort.Direction) Indicates the direction to apply sort key for response values. +optional

Enum flyteidl.admin.Sort.Direction

[flyteidl.admin.Sort.Direction proto]

DESCENDING

(DEFAULT)

ASCENDING

flyteidl.admin.NamedEntityIdentifierListRequest

[flyteidl.admin.NamedEntityIdentifierListRequest proto]

Represents a request structure to list identifiers.

{
  "project": "...",
  "domain": "...",
  "limit": "...",
  "token": "...",
  "sort_by": "{...}"
}
project

(string) Name of the project that contains the identifiers.

domain

(string) Name of the domain the identifiers belongs to within the project.

limit

(uint32) Indicates the number of resources to be returned.

token

(string) In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. +optional

sort_by

(flyteidl.admin.Sort) Sort ordering. +optional

flyteidl.admin.NamedEntityListRequest

[flyteidl.admin.NamedEntityListRequest proto]

Represents a request structure to list NamedEntity objects

{
  "resource_type": "...",
  "project": "...",
  "domain": "...",
  "limit": "...",
  "token": "...",
  "sort_by": "{...}"
}
resource_type

(flyteidl.core.ResourceType)

project

(string) Name of the project that contains the identifiers.

domain

(string) Name of the domain the identifiers belongs to within the project.

limit

(uint32) Indicates the number of resources to be returned.

token

(string) In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. +optional

sort_by

(flyteidl.admin.Sort) Sort ordering. +optional

flyteidl.admin.NamedEntityIdentifierList

[flyteidl.admin.NamedEntityIdentifierList proto]

Represents a list of NamedEntityIdentifiers.

{
  "entities": [],
  "token": "..."
}
entities

(flyteidl.admin.NamedEntityIdentifier) A list of identifiers.

token

(string) In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty.

flyteidl.admin.NamedEntityList

[flyteidl.admin.NamedEntityList proto]

Represents a list of NamedEntityIdentifiers.

{
  "entities": [],
  "token": "..."
}
entities

(flyteidl.admin.NamedEntity) A list of NamedEntity objects

token

(string) In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty.

flyteidl.admin.NamedEntityGetRequest

[flyteidl.admin.NamedEntityGetRequest proto]

A request to retrieve the metadata associated with a NamedEntityIdentifier

{
  "resource_type": "...",
  "id": "{...}"
}
resource_type

(flyteidl.core.ResourceType)

id

(flyteidl.admin.NamedEntityIdentifier)

flyteidl.admin.NamedEntityUpdateRequest

[flyteidl.admin.NamedEntityUpdateRequest proto]

Request to set the referenced launch plan state to the configured value.

{
  "resource_type": "...",
  "id": "{...}",
  "metadata": "{...}"
}
resource_type

(flyteidl.core.ResourceType) Resource type of the metadata to update

id

(flyteidl.admin.NamedEntityIdentifier) Identifier of the metadata to update

metadata

(flyteidl.admin.NamedEntityMetadata) Metadata object to set as the new value

flyteidl.admin.NamedEntityUpdateResponse

[flyteidl.admin.NamedEntityUpdateResponse proto]

Purposefully empty, may be populated in the future.

{}

flyteidl.admin.ObjectGetRequest

[flyteidl.admin.ObjectGetRequest proto]

Represents a structure to fetch a single resource.

{
  "id": "{...}"
}
id

(flyteidl.core.Identifier) Indicates a unique version of resource.

flyteidl.admin.ResourceListRequest

[flyteidl.admin.ResourceListRequest proto]

Represents a request structure to retrieve a list of resources. Resources include: Task, Workflow, LaunchPlan

{
  "id": "{...}",
  "limit": "...",
  "token": "...",
  "filters": "...",
  "sort_by": "{...}"
}
id

(flyteidl.admin.NamedEntityIdentifier) id represents the unique identifier of the resource.

limit

(uint32) Indicates the number of resources to be returned.

token

(string) In the case of multiple pages of results, this server-provided token can be used to fetch the next page in a query. +optional

filters

(string) Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional

sort_by

(flyteidl.admin.Sort) Sort ordering. +optional

flyteidl.admin.EmailNotification

[flyteidl.admin.EmailNotification proto]

{
  "recipients_email": []
}
recipients_email

(string) The list of email addresses recipients for this notification.

flyteidl.admin.PagerDutyNotification

[flyteidl.admin.PagerDutyNotification proto]

{
  "recipients_email": []
}
recipients_email

(string) Currently, PagerDuty notifications leverage email to trigger a notification.

flyteidl.admin.SlackNotification

[flyteidl.admin.SlackNotification proto]

{
  "recipients_email": []
}
recipients_email

(string) Currently, Slack notifications leverage email to trigger a notification.

flyteidl.admin.Notification

[flyteidl.admin.Notification proto]

Represents a structure for notifications based on execution status. The Notification content is configured within Admin. Future iterations could expose configuring notifications with custom content.

{
  "phases": [],
  "email": "{...}",
  "pager_duty": "{...}",
  "slack": "{...}"
}
phases

(flyteidl.core.WorkflowExecution.Phase) A list of phases to which users can associate the notifications to.

email

(flyteidl.admin.EmailNotification) option (validate.required) = true;

Only one of email, pager_duty, slack may be set.

pager_duty

(flyteidl.admin.PagerDutyNotification)

Only one of email, pager_duty, slack may be set.

slack

(flyteidl.admin.SlackNotification)

Only one of email, pager_duty, slack may be set.

flyteidl.admin.UrlBlob

[flyteidl.admin.UrlBlob proto]

Represents a string url and associated metadata used throughout the platform.

{
  "url": "...",
  "bytes": "..."
}
url

(string) Actual url value.

bytes

(int64) Represents the size of the file accessible at the above url.

flyteidl.admin.Labels

[flyteidl.admin.Labels proto]

Label values to be applied to an execution resource. In the future a mode (e.g. OVERRIDE, APPEND, etc) can be defined to specify how to merge labels defined at registration and execution time.

{
  "values": "{...}"
}
values

(map<string, string>) Map of custom labels to be applied to the execution resource.

flyteidl.admin.Annotations

[flyteidl.admin.Annotations proto]

Annotation values to be applied to an execution resource. In the future a mode (e.g. OVERRIDE, APPEND, etc) can be defined to specify how to merge annotations defined at registration and execution time.

{
  "values": "{...}"
}
values

(map<string, string>) Map of custom annotations to be applied to the execution resource.