introduce RefreshMixin

RefreshMixin allows to update a REST object so that you can poll on it.
This is mostly useful for pipelines and jobs, but could be set on most of other objects, with unknown usecases.

2 files changed, 22 insertions, 0 deletions

diff --git a/docs/gl_objects/builds.py b/docs/gl_objects/builds.py
index 0f616e8..03d3653 100644
--- a/docs/gl_objects/builds.py
+++ b/docs/gl_objects/builds.py
@@ -44,6 +44,22 @@ project.triggers.delete(trigger_token)
 trigger.delete()
 # end trigger delete
 
+# pipeline trigger
+def get_or_create_trigger(project):
+    trigger_decription = 'my_trigger_id'
+    for t in project.triggers.list():
+        if t.description == trigger_decription:
+            return t
+    return project.triggers.create({'description': trigger_decription})
+
+trigger = get_or_create_trigger(project)
+pipeline = project.trigger_pipeline('master', trigger.token, variables={"DEPLOY_ZONE": "us-west1"})
+while pipeline.finished_at is None:
+    pipeline.refresh()
+    os.sleep(1)
+
+# end pipeline trigger
+
 # list
 builds = project.builds.list()  # v3
 jobs = project.jobs.list()  # v4
diff --git a/docs/gl_objects/builds.rst b/docs/gl_objects/builds.rst
index 2791188..c9b7330 100644
--- a/docs/gl_objects/builds.rst
+++ b/docs/gl_objects/builds.rst
@@ -102,6 +102,12 @@ Remove a trigger:
    :start-after: # trigger delete
    :end-before: # end trigger delete
 
+Full example with wait for finish:
+
+.. literalinclude:: builds.py
+   :start-after: # pipeline trigger
+   :end-before: # end pipeline trigger
+
 Pipeline schedule
 =================