@flyteorg/flyteidl 1.1.1 → 1.1.4

package/protos/docs/datacatalog/datacatalog.rst

@@ -789,7 +789,9 @@ Tag properties we can filter by
 
 
 
- <!-- end messages -->
+
+..
+   end messages
 
 
 
@@ -837,9 +839,13 @@ as use-cases come up we can add more operators, ex: gte, like, not eq etc.
 
    "EQUALS", "0", ""
 
- <!-- end enums -->
 
- <!-- end HasExtensions -->
+..
+   end enums
+
+
+..
+   end HasExtensions
 
 
 
@@ -865,7 +871,9 @@ Artifacts are associated with a Dataset, and can be tagged for retrieval.
    "ListDatasets", ":ref:`ref_datacatalog.ListDatasetsRequest`", ":ref:`ref_datacatalog.ListDatasetsResponse`", "Return a paginated list of datasets"
    "GetOrExtendReservation", ":ref:`ref_datacatalog.GetOrExtendReservationRequest`", ":ref:`ref_datacatalog.GetOrExtendReservationResponse`", "Attempts to get or extend a reservation for the corresponding artifact. If one already exists (ie. another entity owns the reservation) then that reservation is retrieved. Once you acquire a reservation, you need to periodically extend the reservation with an identical call. If the reservation is not extended before the defined expiration, it may be acquired by another task. Note: We may have multiple concurrent tasks with the same signature and the same input that try to populate the same artifact at the same time. Thus with reservation, only one task can run at a time, until the reservation expires. Note: If task A does not extend the reservation in time and the reservation expires, another task B may take over the reservation, resulting in two tasks A and B running in parallel. So a third task C may get the Artifact from A or B, whichever writes last."
    "ReleaseReservation", ":ref:`ref_datacatalog.ReleaseReservationRequest`", ":ref:`ref_datacatalog.ReleaseReservationResponse`", "Release the reservation when the task holding the spot fails so that the other tasks can grab the spot."
- <!-- end services -->
+
+..
+   end services
 
 
 
@@ -989,13 +997,21 @@ http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.htm
 
 
 
- <!-- end messages -->
 
- <!-- end enums -->
+..
+   end messages
+
+
+..
+   end enums
+
+
+..
+   end HasExtensions
 
- <!-- end HasExtensions -->
 
- <!-- end services -->
+..
+   end services
 
 
 
@@ -1086,13 +1102,21 @@ microsecond should be expressed in JSON format as "3.000001s".
 
 
 
- <!-- end messages -->
 
- <!-- end enums -->
+..
+   end messages
 
- <!-- end HasExtensions -->
 
- <!-- end services -->
+..
+   end enums
+
+
+..
+   end HasExtensions
+
+
+..
+   end services
 
 
 
@@ -1208,7 +1232,9 @@ The JSON representation for `Value` is JSON value.
 
 
 
- <!-- end messages -->
+
+..
+   end messages
 
 
 
@@ -1228,10 +1254,16 @@ NullValue
 
    "NULL_VALUE", "0", "Null value."
 
- <!-- end enums -->
 
- <!-- end HasExtensions -->
+..
+   end enums
+
+
+..
+   end HasExtensions
+
 
- <!-- end services -->
+..
+   end services
 
 

package/protos/docs/event/event.rst

@@ -93,6 +93,7 @@ NodeExecutionEvent
    "event_version", ":ref:`ref_int32`", "", ""
    "is_parent", ":ref:`ref_bool`", "", "Whether this node launched a subworkflow."
    "is_dynamic", ":ref:`ref_bool`", "", "Whether this node yielded a dynamic workflow."
+   "deck_uri", ":ref:`ref_string`", "", "String location uniquely identifying where the deck HTML file is NativeUrl specifies the url in the format of the configured storage provider (e.g. s3://my-bucket/randomstring/suffix.tar)"
 
 
 
@@ -300,7 +301,9 @@ For Workflow Nodes we need to send information about the workflow that's launche
 
 
 
- <!-- end messages -->
+
+..
+   end messages
 
 
 
@@ -318,11 +321,17 @@ Includes the broad category of machine used for this specific task execution.
    "DEFAULT", "0", "The default instance class configured for the flyte application platform."
    "INTERRUPTIBLE", "1", "The instance class configured for interruptible tasks."
 
- <!-- end enums -->
 
- <!-- end HasExtensions -->
+..
+   end enums
+
+
+..
+   end HasExtensions
+
 
- <!-- end services -->
+..
+   end services
 
 
 
@@ -446,13 +455,21 @@ http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.htm
 
 
 
- <!-- end messages -->
 
- <!-- end enums -->
+..
+   end messages
+
+
+..
+   end enums
+
+
+..
+   end HasExtensions
 
- <!-- end HasExtensions -->
 
- <!-- end services -->
+..
+   end services
 
 
 
@@ -543,13 +560,21 @@ microsecond should be expressed in JSON format as "3.000001s".
 
 
 
- <!-- end messages -->
 
- <!-- end enums -->
+..
+   end messages
 
- <!-- end HasExtensions -->
 
- <!-- end services -->
+..
+   end enums
+
+
+..
+   end HasExtensions
+
+
+..
+   end services
 
 
 
@@ -665,7 +690,9 @@ The JSON representation for `Value` is JSON value.
 
 
 
- <!-- end messages -->
+
+..
+   end messages
 
 
 
@@ -685,10 +712,16 @@ NullValue
 
    "NULL_VALUE", "0", "Null value."
 
- <!-- end enums -->
 
- <!-- end HasExtensions -->
+..
+   end enums
+
+
+..
+   end HasExtensions
+
 
- <!-- end services -->
+..
+   end services
 
 

package/protos/docs/plugins/plugins.rst

@@ -37,13 +37,21 @@ will be executed concurrently.
 
 
 
- <!-- end messages -->
 
- <!-- end enums -->
+..
+   end messages
 
- <!-- end HasExtensions -->
 
- <!-- end services -->
+..
+   end enums
+
+
+..
+   end HasExtensions
+
+
+..
+   end services
 
 
 
@@ -79,13 +87,21 @@ Custom proto for plugin that enables distributed training using https://github.c
 
 
 
- <!-- end messages -->
 
- <!-- end enums -->
+..
+   end messages
+
+
+..
+   end enums
 
- <!-- end HasExtensions -->
 
- <!-- end services -->
+..
+   end HasExtensions
+
+
+..
+   end services
 
 
 
@@ -122,13 +138,21 @@ of a Presto task's TaskTemplate
 
 
 
- <!-- end messages -->
 
- <!-- end enums -->
+..
+   end messages
+
+
+..
+   end enums
+
+
+..
+   end HasExtensions
 
- <!-- end HasExtensions -->
 
- <!-- end services -->
+..
+   end services
 
 
 
@@ -161,13 +185,21 @@ Custom proto for plugin that enables distributed training using https://github.c
 
 
 
- <!-- end messages -->
 
- <!-- end enums -->
+..
+   end messages
 
- <!-- end HasExtensions -->
 
- <!-- end services -->
+..
+   end enums
+
+
+..
+   end HasExtensions
+
+
+..
+   end services
 
 
 
@@ -248,101 +280,21 @@ of a hive task's TaskTemplate
 
 
 
- <!-- end messages -->
-
- <!-- end enums -->
-
- <!-- end HasExtensions -->
-
- <!-- end services -->
-
-
-
-
-.. _ref_flyteidl/plugins/sidecar.proto:
-
-flyteidl/plugins/sidecar.proto
-==================================================================
-
-
-
-
-
-.. _ref_flyteidl.plugins.SidecarJob:
-
-SidecarJob
-------------------------------------------------------------------
-
-A sidecar job brings up the desired pod_spec.
-The plugin executor is responsible for keeping the pod alive until the primary container terminates
-or the task itself times out.
-
-
-
-.. csv-table:: SidecarJob type fields
-   :header: "Field", "Type", "Label", "Description"
-   :widths: auto
-
-   "pod_spec", ":ref:`ref_k8s.io.api.core.v1.PodSpec`", "", ""
-   "primary_container_name", ":ref:`ref_string`", "", ""
-   "annotations", ":ref:`ref_flyteidl.plugins.SidecarJob.AnnotationsEntry`", "repeated", "Pod annotations"
-   "labels", ":ref:`ref_flyteidl.plugins.SidecarJob.LabelsEntry`", "repeated", "Pod labels"
-
-
-
-
-
-
 
-.. _ref_flyteidl.plugins.SidecarJob.AnnotationsEntry:
-
-SidecarJob.AnnotationsEntry
-------------------------------------------------------------------
-
-
-
-
-
-.. csv-table:: SidecarJob.AnnotationsEntry type fields
-   :header: "Field", "Type", "Label", "Description"
-   :widths: auto
-
-   "key", ":ref:`ref_string`", "", ""
-   "value", ":ref:`ref_string`", "", ""
+..
+   end messages
 
 
+..
+   end enums
 
 
+..
+   end HasExtensions
 
 
-
-.. _ref_flyteidl.plugins.SidecarJob.LabelsEntry:
-
-SidecarJob.LabelsEntry
-------------------------------------------------------------------
-
-
-
-
-
-.. csv-table:: SidecarJob.LabelsEntry type fields
-   :header: "Field", "Type", "Label", "Description"
-   :widths: auto
-
-   "key", ":ref:`ref_string`", "", ""
-   "value", ":ref:`ref_string`", "", ""
-
-
-
-
-
- <!-- end messages -->
-
- <!-- end enums -->
-
- <!-- end HasExtensions -->
-
- <!-- end services -->
+..
+   end services
 
 
 
@@ -438,7 +390,9 @@ SparkJob.SparkConfEntry
 
 
 
- <!-- end messages -->
+
+..
+   end messages
 
 
 
@@ -458,11 +412,17 @@ SparkApplication.Type
    "SCALA", "2", ""
    "R", "3", ""
 
- <!-- end enums -->
 
- <!-- end HasExtensions -->
+..
+   end enums
 
- <!-- end services -->
+
+..
+   end HasExtensions
+
+
+..
+   end services
 
 
 
@@ -497,13 +457,21 @@ Custom proto for plugin that enables distributed training using https://github.c
 
 
 
- <!-- end messages -->
 
- <!-- end enums -->
+..
+   end messages
+
+
+..
+   end enums
+
 
- <!-- end HasExtensions -->
+..
+   end HasExtensions
 
- <!-- end services -->
+
+..
+   end services
 
 
 
@@ -538,12 +506,20 @@ Represents an Execution that was launched and could be waited on.
 
 
 
- <!-- end messages -->
 
- <!-- end enums -->
+..
+   end messages
+
+
+..
+   end enums
+
+
+..
+   end HasExtensions
 
- <!-- end HasExtensions -->
 
- <!-- end services -->
+..
+   end services
 
 

package/protos/docs/restructuredtext.tmpl

@@ -0,0 +1,129 @@
+######################
+Protocol Documentation
+######################
+
+{{range .Files}}
+{{$file_name := .Name}}
+
+.. _ref_{{.Name}}:
+
+{{.Name}}
+==================================================================
+
+{{.Description}}
+
+{{range .Messages}}
+
+.. _ref_{{.FullName}}:
+
+{{.LongName}}
+------------------------------------------------------------------
+
+{{.Description}}
+
+{{if .HasFields}}
+
+.. csv-table:: {{.LongName}} type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+{{range .Fields }}
+   "{{.Name}}", ":ref:`ref_{{.FullType}}`", "{{.Label}}", "{{if (index .Options "deprecated"|default false)}}**Deprecated.** {{end}}{{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}}"
+{{- end}}
+{{end}}
+
+
+{{if .HasExtensions}}
+
+.. csv-table:: {{.LongName}} type extensions
+   :header: "Extension", "Type", "Base", "Number", "Description"
+   :widths: auto
+{{range .Extensions }}
+   "{{.Name}}", "{{.LongType}}", "{{.ContainingLongType}}", "{{.Number}}", "{{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}}"
+{{- end}}
+{{end}}
+
+{{end}}
+..
+   end messages
+
+{{range .Enums}}
+
+.. _ref_{{.FullName}}:
+
+{{.LongName}}
+------------------------------------------------------------------
+
+{{.Description}}
+
+.. csv-table:: Enum {{.LongName}} values
+   :header: "Name", "Number", "Description"
+   :widths: auto
+{{range .Values }}
+   "{{.Name}}", "{{.Number}}", "{{nobr .Description}}"
+{{- end}}
+
+{{end}}
+..
+   end enums
+
+{{if .HasExtensions}}
+
+.. _ref_{{$file_name}}_extensions:
+
+File-level Extensions
+--------------------------------------------------------------------------------
+
+.. csv-table:: {{.Name}} file-level Extensions
+   :header: "Extension", "Type", "Base", "Number", "Description"
+   :widths: auto
+{{range .Extensions}}
+   "{{.Name}}", "{{.LongType}}", "{{.ContainingLongType}}", "{{.Number}}", "{{nobr .Description}}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}}"
+{{- end}}
+{{end}}
+..
+   end HasExtensions
+
+{{range .Services}}
+
+.. _ref_{{.FullName}}:
+
+{{.Name}}
+------------------------------------------------------------------
+
+{{.Description}}
+
+.. csv-table:: {{.Name}} service methods
+   :header: "Method Name", "Request Type", "Response Type", "Description"
+   :widths: auto
+{{range .Methods}}
+   "{{.Name}}", ":ref:`ref_{{.RequestFullType}}`{{if .RequestStreaming}} stream{{end}}", ":ref:`ref_{{.ResponseFullType}}`{{if .ResponseStreaming}} stream{{end}}", "{{nobr .Description}}"
+{{- end}}
+{{end}}
+..
+   end services
+
+{{end}}
+
+.. _ref_scala_types:
+
+Scalar Value Types
+==================
+
+{{range .Scalars}}
+
+.. _ref_{{.ProtoType}}:
+
+{{.ProtoType}}
+-----------------------------
+
+{{.Notes}}
+
+.. csv-table:: {{.ProtoType}} language representation
+   :header: ".proto Type", "C++", "Java", "Python", "Go", "C#", "PHP", "Ruby"
+   :widths: auto
+
+   "{{.ProtoType}}", "{{.CppType}}", "{{.JavaType}}", "{{.PythonType}}", "{{.GoType}}", "{{.CSharp}}", "{{.PhpType}}", "{{.RubyType}}"
+
+{{end}}
+..
+   end scalars