v0.3.0 docs updated (#303)

flyteorg · May 1, 2020 · 2f0c4a3 · 2f0c4a3
1 parent 44027b1
commit 2f0c4a3
Show file tree

Hide file tree

Showing 260 changed files with 2,083 additions and 423 deletions.
diff --git a/_modules/abc.html b/_modules/abc.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>abc &mdash; Flyte 0.0.1 documentation</title>
+  <title>abc &mdash; Flyte 0.3.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/clients/friendly.html b/_modules/flytekit/clients/friendly.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clients.friendly &mdash; Flyte 0.0.1 documentation</title>
+  <title>flytekit.clients.friendly &mdash; Flyte 0.3.0 documentation</title>
 
 
 
@@ -709,6 +709,29 @@ <h1>Source code for flytekit.clients.friendly</h1><div class="highlight"><pre>
             <span class="p">)</span>
         <span class="p">)</span></div>
 
+    <span class="c1">####################################################################################################################</span>
+    <span class="c1">#</span>
+    <span class="c1">#  Named Entity Endpoints</span>
+    <span class="c1">#</span>
+    <span class="c1">####################################################################################################################</span>
+
+<div class="viewcode-block" id="SynchronousFlyteClient.update_named_entity"><a class="viewcode-back" href="../../../flytekit/flytekit.clients.html#flytekit.clients.friendly.SynchronousFlyteClient.update_named_entity">[docs]</a>    <span class="k">def</span> <span class="nf">update_named_entity</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resource_type</span><span class="p">,</span> <span class="nb">id</span><span class="p">,</span> <span class="n">metadata</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Updates the metadata associated with a named entity.  A named entity is designated a resource, e.g. a workflow,</span>
+<span class="sd">        task or launch plan specified by {project, domain, name} across all versions of the resource.</span>
+
+<span class="sd">        :param int resource_type: Enum value from flytekit.models.identifier.ResourceType</span>
+<span class="sd">        :param flytekit.models.admin.named_entity.NamedEntityIdentifier id: identifier for named entity to update</span>
+<span class="sd">        :param flytekit.models.admin.named_entity.NamedEntityIdentifierMetadata metadata:</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="nb">super</span><span class="p">(</span><span class="n">SynchronousFlyteClient</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">update_named_entity</span><span class="p">(</span>
+            <span class="n">_common_pb2</span><span class="o">.</span><span class="n">NamedEntityUpdateRequest</span><span class="p">(</span>
+                <span class="n">resource_type</span><span class="o">=</span><span class="n">resource_type</span><span class="p">,</span>
+                <span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="o">.</span><span class="n">to_flyte_idl</span><span class="p">(),</span>
+                <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="o">.</span><span class="n">to_flyte_idl</span><span class="p">(),</span>
+            <span class="p">)</span>
+        <span class="p">)</span></div>
+
     <span class="c1">####################################################################################################################</span>
     <span class="c1">#</span>
     <span class="c1">#  Execution Endpoints</span>

diff --git a/_modules/flytekit/clients/helpers.html b/_modules/flytekit/clients/helpers.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clients.helpers &mdash; Flyte 0.0.1 documentation</title>
+  <title>flytekit.clients.helpers &mdash; Flyte 0.3.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/clients/raw.html b/_modules/flytekit/clients/raw.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clients.raw &mdash; Flyte 0.0.1 documentation</title>
+  <title>flytekit.clients.raw &mdash; Flyte 0.3.0 documentation</title>
 
 
 
@@ -558,6 +558,20 @@ <h1>Source code for flytekit.clients.raw</h1><div class="highlight"><pre>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stub</span><span class="o">.</span><span class="n">ListActiveLaunchPlans</span><span class="p">(</span><span class="n">active_launch_plan_list_request</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_metadata</span><span class="p">)</span></div>
 
+    <span class="c1">####################################################################################################################</span>
+    <span class="c1">#</span>
+    <span class="c1">#  Named Entity Endpoints</span>
+    <span class="c1">#</span>
+    <span class="c1">####################################################################################################################</span>
+
+<div class="viewcode-block" id="RawSynchronousFlyteClient.update_named_entity"><a class="viewcode-back" href="../../../flytekit/flytekit.clients.html#flytekit.clients.raw.RawSynchronousFlyteClient.update_named_entity">[docs]</a>    <span class="nd">@_handle_rpc_error</span>
+    <span class="k">def</span> <span class="nf">update_named_entity</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">update_named_entity_request</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        :param flyteidl.admin.common_pb2.NamedEntityUpdateRequest update_named_entity_request:</span>
+<span class="sd">        :rtype: flyteidl.admin.common_pb2.NamedEntityUpdateResponse</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stub</span><span class="o">.</span><span class="n">UpdateNamedEntity</span><span class="p">(</span><span class="n">update_named_entity_request</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_metadata</span><span class="p">)</span></div>
+
     <span class="c1">####################################################################################################################</span>
     <span class="c1">#</span>
     <span class="c1">#  Workflow Execution Endpoints</span>

diff --git a/_modules/flytekit/clis/auth/auth.html b/_modules/flytekit/clis/auth/auth.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clis.auth.auth &mdash; Flyte 0.0.1 documentation</title>
+  <title>flytekit.clis.auth.auth &mdash; Flyte 0.3.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/clis/auth/credentials.html b/_modules/flytekit/clis/auth/credentials.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clis.auth.credentials &mdash; Flyte 0.0.1 documentation</title>
+  <title>flytekit.clis.auth.credentials &mdash; Flyte 0.3.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/clis/auth/discovery.html b/_modules/flytekit/clis/auth/discovery.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clis.auth.discovery &mdash; Flyte 0.0.1 documentation</title>
+  <title>flytekit.clis.auth.discovery &mdash; Flyte 0.3.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/clis/helpers.html b/_modules/flytekit/clis/helpers.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clis.helpers &mdash; Flyte 0.0.1 documentation</title>
+  <title>flytekit.clis.helpers &mdash; Flyte 0.3.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/clis/sdk_in_container/basic_auth.html b/_modules/flytekit/clis/sdk_in_container/basic_auth.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clis.sdk_in_container.basic_auth &mdash; Flyte 0.0.1 documentation</title>
+  <title>flytekit.clis.sdk_in_container.basic_auth &mdash; Flyte 0.3.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/clis/sdk_in_container/launch_plan.html b/_modules/flytekit/clis/sdk_in_container/launch_plan.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clis.sdk_in_container.launch_plan &mdash; Flyte 0.0.1 documentation</title>
+  <title>flytekit.clis.sdk_in_container.launch_plan &mdash; Flyte 0.3.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/clis/sdk_in_container/pyflyte.html b/_modules/flytekit/clis/sdk_in_container/pyflyte.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clis.sdk_in_container.pyflyte &mdash; Flyte 0.0.1 documentation</title>
+  <title>flytekit.clis.sdk_in_container.pyflyte &mdash; Flyte 0.3.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/clis/sdk_in_container/register.html b/_modules/flytekit/clis/sdk_in_container/register.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clis.sdk_in_container.register &mdash; Flyte 0.0.1 documentation</title>
+  <title>flytekit.clis.sdk_in_container.register &mdash; Flyte 0.3.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/clis/sdk_in_container/serialize.html b/_modules/flytekit/clis/sdk_in_container/serialize.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.clis.sdk_in_container.serialize &mdash; Flyte 0.0.1 documentation</title>
+  <title>flytekit.clis.sdk_in_container.serialize &mdash; Flyte 0.3.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/common/component_nodes.html b/_modules/flytekit/common/component_nodes.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.common.component_nodes &mdash; Flyte 0.0.1 documentation</title>
+  <title>flytekit.common.component_nodes &mdash; Flyte 0.3.0 documentation</title>
 
 
 
@@ -223,9 +223,24 @@ <h1>Source code for flytekit.common.component_nodes</h1><div class="highlight"><
 <span class="sd">        :param flytekit.common.workflow.SdkWorkflow sdk_workflow:</span>
 <span class="sd">        :param flytekit.common.launch_plan.SdkLaunchPlan sdk_launch_plan:</span>
 <span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">if</span> <span class="n">sdk_workflow</span> <span class="ow">and</span> <span class="n">sdk_launch_plan</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="n">_system_exceptions</span><span class="o">.</span><span class="n">FlyteSystemException</span><span class="p">(</span><span class="s2">&quot;SdkWorkflowNode cannot be called with both a workflow and &quot;</span>
+                                                          <span class="s2">&quot;a launchplan specified, please pick one. WF: </span><span class="si">{}</span><span class="s2"> LP: </span><span class="si">{}</span><span class="s2">&quot;</span><span class="p">,</span>
+                                                          <span class="n">sdk_workflow</span><span class="p">,</span> <span class="n">sdk_launch_plan</span><span class="p">)</span>
+
         <span class="bp">self</span><span class="o">.</span><span class="n">_sdk_workflow</span> <span class="o">=</span> <span class="n">sdk_workflow</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_sdk_launch_plan</span> <span class="o">=</span> <span class="n">sdk_launch_plan</span>
-        <span class="nb">super</span><span class="p">(</span><span class="n">SdkWorkflowNode</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
+        <span class="n">sdk_wf_id</span> <span class="o">=</span> <span class="n">sdk_workflow</span><span class="o">.</span><span class="n">id</span> <span class="k">if</span> <span class="n">sdk_workflow</span> <span class="k">else</span> <span class="kc">None</span>
+        <span class="n">sdk_lp_id</span> <span class="o">=</span> <span class="n">sdk_launch_plan</span><span class="o">.</span><span class="n">id</span> <span class="k">if</span> <span class="n">sdk_launch_plan</span> <span class="k">else</span> <span class="kc">None</span>
+        <span class="nb">super</span><span class="p">(</span><span class="n">SdkWorkflowNode</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">launchplan_ref</span><span class="o">=</span><span class="n">sdk_lp_id</span><span class="p">,</span> <span class="n">sub_workflow_ref</span><span class="o">=</span><span class="n">sdk_wf_id</span><span class="p">)</span>
+
+    <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        :rtype: Text</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">sdk_workflow</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="k">return</span> <span class="s2">&quot;SdkWorkflowNode with workflow: </span><span class="si">{}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sdk_workflow</span><span class="p">)</span>
+        <span class="k">return</span> <span class="s2">&quot;SdkWorkflowNode with launch plan: </span><span class="si">{}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sdk_launch_plan</span><span class="p">)</span>
 
     <span class="nd">@property</span>
     <span class="k">def</span> <span class="nf">launchplan_ref</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

diff --git a/_modules/flytekit/common/constants.html b/_modules/flytekit/common/constants.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.common.constants &mdash; Flyte 0.0.1 documentation</title>
+  <title>flytekit.common.constants &mdash; Flyte 0.3.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/common/core/identifier.html b/_modules/flytekit/common/core/identifier.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.common.core.identifier &mdash; Flyte 0.0.1 documentation</title>
+  <title>flytekit.common.core.identifier &mdash; Flyte 0.3.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/common/exceptions/base.html b/_modules/flytekit/common/exceptions/base.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.common.exceptions.base &mdash; Flyte 0.0.1 documentation</title>
+  <title>flytekit.common.exceptions.base &mdash; Flyte 0.3.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/common/exceptions/scopes.html b/_modules/flytekit/common/exceptions/scopes.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.common.exceptions.scopes &mdash; Flyte 0.0.1 documentation</title>
+  <title>flytekit.common.exceptions.scopes &mdash; Flyte 0.3.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/common/exceptions/system.html b/_modules/flytekit/common/exceptions/system.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.common.exceptions.system &mdash; Flyte 0.0.1 documentation</title>
+  <title>flytekit.common.exceptions.system &mdash; Flyte 0.3.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/common/exceptions/user.html b/_modules/flytekit/common/exceptions/user.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.common.exceptions.user &mdash; Flyte 0.0.1 documentation</title>
+  <title>flytekit.common.exceptions.user &mdash; Flyte 0.3.0 documentation</title>
 
 
 

diff --git a/_modules/flytekit/common/interface.html b/_modules/flytekit/common/interface.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>flytekit.common.interface &mdash; Flyte 0.0.1 documentation</title>
+  <title>flytekit.common.interface &mdash; Flyte 0.3.0 documentation</title>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,7 +8,7 @@

		<meta name="viewport" content="width=device-width, initial-scale=1.0">

		<title>abc — Flyte 0.0.1 documentation</title>
		<title>abc — Flyte 0.3.0 documentation</title>



Expand Down