diff --git a/.yardoc/checksums b/.yardoc/checksums index 020ebd3..099439d 100644 --- a/.yardoc/checksums +++ b/.yardoc/checksums @@ -3,7 +3,7 @@ lib/sfrest/cron.rb b79eca6a734af70d17053ca85518e9f62737434f lib/sfrest/info.rb ba9d80b54d182490ea894dc832d338705ccadf3e lib/sfrest/role.rb 14f829291f7c0b54b35acab383e01535f25e763a lib/sfrest/site.rb d101ddf331e15e941506fda4d7ad2248ae8eca31 -lib/sfrest/task.rb 1185c121635cf0849cb9185dcfb366930a8ea971 +lib/sfrest/task.rb f404ebbdcc21815653802d8b0c7ecbdba86ce6d4 lib/sfrest/user.rb c00d77c9be76b447b3c5410624d106f638840721 lib/sfrest/audit.rb 83b4ed11bb31fb500d59f98b573afd1be7686887 lib/sfrest/error.rb 11e22e8c019e8ed00d3f8830db3f8c1b304d37ca @@ -15,7 +15,7 @@ lib/sfrest/backup.rb b938242b1442f8e4e9e112aa2b00e7706e2eb756 lib/sfrest/update.rb 2dc95ca50ab0d7017ac1296b80d1c417a5e9d834 lib/sfrest/domains.rb 2774e0f43de5ef3af79f108a9aea78e9b6e0e9c3 lib/sfrest/profile.rb e506ccffecf7a8cf34e420924243250de38d8e6b -lib/sfrest/version.rb d1c11762d749c5f1103e2d2d55a033525efc95e7 +lib/sfrest/version.rb fbb3930e93ff0af2ec9c7805d033d81de4b1c3c2 lib/sfrest/codebase.rb 86aec3743bd186f1a5bce5e8db27a57444fc1668 lib/sfrest/variable.rb 29d5899e356488e2f58df6841b80b67cc6b43d06 lib/sfrest/collection.rb 60a123604d676b82cc1b2a97d9288637a0e3f3d1 diff --git a/.yardoc/object_types b/.yardoc/object_types index 1e18947..8e5e777 100644 Binary files a/.yardoc/object_types and b/.yardoc/object_types differ diff --git a/.yardoc/objects/root.dat b/.yardoc/objects/root.dat index 0c23c2b..67f26ab 100644 Binary files a/.yardoc/objects/root.dat and b/.yardoc/objects/root.dat differ diff --git a/doc/SFRest.html b/doc/SFRest.html index 0107c3d..ea4ccee 100644 --- a/doc/SFRest.html +++ b/doc/SFRest.html @@ -129,7 +129,7 @@
'0.0.45'
'0.0.46'
Deletes a specific task identified by its task id.
+ + + +Retrieve a specific task by ID.
+-263 -264 -265 -266+271 +272 +273 +274
# File 'lib/sfrest/task.rb', line 263 +# File 'lib/sfrest/task.rb', line 271 def delete_task(task_id) current_path = "/api/v1/tasks/#{task_id}" @@ -1135,6 +1159,87 @@
Retrieve a specific task by ID.
+ + +
+ + + +178 +179 +180 +181+ |
+
+ # File 'lib/sfrest/task.rb', line 178 + +def find_task(task_id) + current_path = "/api/v1/tasks/#{task_id}" + @conn.get(current_path) +end+ |
+
-271 -272 -273 -274+279 +280 +281 +282
# File 'lib/sfrest/task.rb', line 271 +# File 'lib/sfrest/task.rb', line 279 def get_task_class_info(type = '') current_path = "/api/v1/classes/#{type}" @@ -1623,23 +1728,23 @@
-180 -181 -182 -183 -184 -185 -186 -187 188 189 190 191 192 -193+193 +194 +195 +196 +197 +198 +199 +200 +201
# File 'lib/sfrest/task.rb', line 180 +# File 'lib/sfrest/task.rb', line 188 def get_task_id(name, group = nil, klass = nil, status = nil) page_size = 100 @@ -1701,13 +1806,13 @@
-211 -212 -213 -214+219 +220 +221 +222
# File 'lib/sfrest/task.rb', line 211 +# File 'lib/sfrest/task.rb', line 219 def get_task_logs(task_id) current_path = "/api/v1/tasks/#{task_id}/logs" @@ -1772,13 +1877,13 @@
-279 -280 -281 -282+287 +288 +289 +290
# File 'lib/sfrest/task.rb', line 279 +# File 'lib/sfrest/task.rb', line 287 def get_wip_task_status(task_id) current_path = "/api/v1/wip/task/#{task_id}/status" @@ -1828,20 +1933,20 @@
-219 -220 -221 -222 -223 -224 -225 -226 227 228 -229+229 +230 +231 +232 +233 +234 +235 +236 +237
# File 'lib/sfrest/task.rb', line 219 +# File 'lib/sfrest/task.rb', line 227 def globally_paused? paused = false @@ -1885,14 +1990,14 @@
-196 -197 -198 -199 -200+204 +205 +206 +207 +208
# File 'lib/sfrest/task.rb', line 196 +# File 'lib/sfrest/task.rb', line 204 def pause_all_tasks current_path = '/api/v1/pause' @@ -1963,14 +2068,14 @@
-235 -236 -237 -238 -239+243 +244 +245 +246 +247
# File 'lib/sfrest/task.rb', line 235 +# File 'lib/sfrest/task.rb', line 243 def pause_task(task_id, level = 'family') current_path = "/api/v1/pause/#{task_id}" @@ -2008,14 +2113,14 @@
-203 -204 -205 -206 -207+211 +212 +213 +214 +215
# File 'lib/sfrest/task.rb', line 203 +# File 'lib/sfrest/task.rb', line 211 def resume_all_tasks current_path = '/api/v1/pause' @@ -2086,14 +2191,14 @@
-245 -246 -247 -248 -249+253 +254 +255 +256 +257
# File 'lib/sfrest/task.rb', line 245 +# File 'lib/sfrest/task.rb', line 253 def resume_task(task_id, level = 'family') current_path = "/api/v1/pause/#{task_id}" @@ -3102,14 +3207,14 @@
-254 -255 -256 -257 -258+262 +263 +264 +265 +266
# File 'lib/sfrest/task.rb', line 254 +# File 'lib/sfrest/task.rb', line 262 def terminate_task(task_id) current_path = "/api/v1/tasks/#{task_id}/terminate" @@ -3180,12 +3285,12 @@
-287 -288 -289+295 +296 +297
# File 'lib/sfrest/task.rb', line 287 +# File 'lib/sfrest/task.rb', line 295 def wait_until_done(task_id, max_nap = 600) wait_until_state(task_id, 'done', max_nap) @@ -3268,21 +3373,21 @@
-295 -296 -297 -298 -299 -300 -301 -302 303 304 305 -306+306 +307 +308 +309 +310 +311 +312 +313 +314
# File 'lib/sfrest/task.rb', line 295 +# File 'lib/sfrest/task.rb', line 303 def wait_until_state(task_id, state, max_nap) blink_time = 5 # wake up and scan @@ -3306,9 +3411,9 @@diff --git a/doc/SFRest/TaskNotDoneError.html b/doc/SFRest/TaskNotDoneError.html index 276ccf6..3498b4a 100644 --- a/doc/SFRest/TaskNotDoneError.html +++ b/doc/SFRest/TaskNotDoneError.html @@ -133,9 +133,9 @@
Overview
diff --git a/doc/SFRest/Task_log_settings.html b/doc/SFRest/Task_log_settings.html index ef3a675..b4cd7d6 100644 --- a/doc/SFRest/Task_log_settings.html +++ b/doc/SFRest/Task_log_settings.html @@ -520,9 +520,9 @@diff --git a/doc/SFRest/Theme.html b/doc/SFRest/Theme.html index db47721..245c229 100644 --- a/doc/SFRest/Theme.html +++ b/doc/SFRest/Theme.html @@ -363,9 +363,9 @@
diff --git a/doc/SFRest/UnprocessableEntity.html b/doc/SFRest/UnprocessableEntity.html index fee2696..9b59ec2 100644 --- a/doc/SFRest/UnprocessableEntity.html +++ b/doc/SFRest/UnprocessableEntity.html @@ -133,9 +133,9 @@
Overview
diff --git a/doc/SFRest/Update.html b/doc/SFRest/Update.html index b2e23ef..6f17e60 100644 --- a/doc/SFRest/Update.html +++ b/doc/SFRest/Update.html @@ -1311,9 +1311,9 @@diff --git a/doc/SFRest/Usage.html b/doc/SFRest/Usage.html index 50ccf5c..e9ff492 100644 --- a/doc/SFRest/Usage.html +++ b/doc/SFRest/Usage.html @@ -375,9 +375,9 @@
diff --git a/doc/SFRest/User.html b/doc/SFRest/User.html index 6325996..7c432c1 100644 --- a/doc/SFRest/User.html +++ b/doc/SFRest/User.html @@ -1169,9 +1169,9 @@
diff --git a/doc/SFRest/Variable.html b/doc/SFRest/Variable.html index 2f808e0..fd430f2 100644 --- a/doc/SFRest/Variable.html +++ b/doc/SFRest/Variable.html @@ -428,9 +428,9 @@
diff --git a/doc/_index.html b/doc/_index.html index 8569f86..4777d3f 100644 --- a/doc/_index.html +++ b/doc/_index.html @@ -448,9 +448,9 @@
Namespace Listing A-Z
diff --git a/doc/file.README.html b/doc/file.README.html index 7b88ade..953e62f 100644 --- a/doc/file.README.html +++ b/doc/file.README.html @@ -88,9 +88,9 @@Contributing
diff --git a/doc/index.html b/doc/index.html index 7b0c261..ff61dce 100644 --- a/doc/index.html +++ b/doc/index.html @@ -88,9 +88,9 @@Contributing
diff --git a/doc/method_list.html b/doc/method_list.html index c7a0ff2..c6d0b0f 100644 --- a/doc/method_list.html +++ b/doc/method_list.html @@ -70,16 +70,16 @@Method List
- #add_sites - SFRest::Collection + #add_sites + SFRest::Group@@ -318,16 +318,16 @@ - #add_sites - SFRest::Group + #add_sites + SFRest::CollectionMethod List
@@ -518,7 +518,7 @@ Method List
@@ -526,7 +526,7 @@ - #find_task_ids + #find_task SFRest::TaskMethod List
@@ -534,24 +534,24 @@ - #find_tasks + #find_task_ids SFRest::TaskMethod List
- #first_collection_id - SFRest::Collection + #find_tasks + SFRest::Task - #first_site_id - SFRest::Site + #first_collection_id + SFRest::Collection@@ -566,13 +566,21 @@ - #get - SFRest::Domains + #first_site_id + SFRest::SiteMethod List
+ + + ++ #get_all + SFRest::Domains ++ #get_backups SFRest::Backup @@ -580,7 +588,7 @@Method List
-+ #get_collection_data SFRest::Collection @@ -588,7 +596,7 @@Method List
-+ #get_collection_id SFRest::Collection @@ -596,7 +604,7 @@Method List
-+ #get_cron_job SFRest::Cron @@ -604,7 +612,7 @@Method List
-+ #get_cron_jobs SFRest::Cron @@ -612,7 +620,7 @@Method List
-+ #get_group SFRest::Group @@ -620,7 +628,7 @@Method List
-+ #get_group_id SFRest::Group @@ -628,7 +636,7 @@Method List
-+ #get_members SFRest::Group @@ -636,7 +644,7 @@Method List
-+ #get_role_id SFRest::Role @@ -644,7 +652,7 @@Method List
-+ #get_site_data SFRest::Site @@ -652,7 +660,7 @@Method List
-+ #get_site_id SFRest::Site @@ -660,7 +668,7 @@Method List
-+ #get_task_class_info SFRest::Task @@ -668,7 +676,7 @@Method List
-+ #get_task_id SFRest::Task @@ -676,7 +684,7 @@Method List
-+ #get_task_logs SFRest::Task @@ -684,7 +692,7 @@Method List
-+ #get_user_data SFRest::User @@ -692,7 +700,7 @@Method List
-+ #get_user_id SFRest::User @@ -700,7 +708,7 @@Method List
-+ #get_variable SFRest::Variable @@ -708,7 +716,7 @@Method List
-+ #get_wip_task_status SFRest::Task @@ -716,7 +724,7 @@Method List
-+ #get_with_status SFRest::Connection @@ -724,7 +732,7 @@Method List
-+ #globally_paused? SFRest::Task @@ -732,7 +740,7 @@Method List
-+ #group_data_from_results SFRest::Group @@ -740,7 +748,7 @@Method List
-+ #group_list SFRest::Group @@ -748,58 +756,66 @@Method List
++ + ++ #initialize + SFRest::Site_guard ++ - #initialize - SFRest::Site + #initialize + SFRest::Variable - #initialize - SFRest::Connection + #initialize + SFRest::Usage - #initialize - SFRest::Task + #initialize + SFRest::Group - #initialize - SFRest::Audit + #initialize + SFRest::Backup - #initialize - SFRest::Group + #initialize + SFRest::Audit - #initialize - SFRest::User + #initialize + SFRest::Task@@ -814,96 +830,96 @@ - #initialize - SFRest::Centralized_role_management + #initialize + SFRest::DomainsMethod List
- #initialize - SFRest::Collection + #initialize + SFRest::User - #initialize - SFRest::Stage + #initialize + SFRest::Centralized_role_management - #initialize - SFRest::Info + #initialize + SFRest::Stage - #initialize - SFRest::Factory_standard_domain + #initialize + SFRest::Info - #initialize - SFRest::Theme + #initialize + SFRest::Factory_standard_domain - #initialize - SFRest::Site_guard + #initialize + SFRest::Theme - #initialize - SFRest::Variable + #initialize + SFRest::Task_log_settings - #initialize - SFRest::Usage + #initialize + SFRest::Security_settings - #initialize - SFRest::Backup + #initialize + SFRest::Connection - #initialize - SFRest::Codebase + #initialize + SFRest::Collection - #initialize - SFRest::Update + #initialize + SFRest::Codebase@@ -918,45 +934,37 @@ - #initialize - SFRest::Domains + #initialize + SFRest::UpdateMethod List
- #initialize - SFRest::Site_update_priority + #initialize + SFRest::Site - #initialize - SFRest::Site_ownership + #initialize + SFRest::Site_update_priority - #initialize - SFRest::Profile + #initialize + SFRest::Site_ownership - #initialize - SFRest::Security_settings + #initialize + SFRest::Profile- - - -- #initialize - SFRest::Task_log_settings -- #list SFRest::Codebase @@ -964,7 +972,7 @@Method List
-+ #list_audit_events SFRest::Audit @@ -972,7 +980,7 @@Method List
-+ #list_staging_environments SFRest::Stage @@ -980,7 +988,7 @@Method List
-+ #list_vcs_refs SFRest::Update @@ -988,7 +996,7 @@Method List
-+ #make_default_owner SFRest::Site_ownership @@ -996,7 +1004,7 @@Method List
-+ #modify_status SFRest::Update @@ -1004,7 +1012,7 @@Method List
-+ #monthly SFRest::Usage @@ -1012,7 +1020,7 @@Method List
-+ #multi_stack? SFRest::Update @@ -1020,7 +1028,7 @@Method List
-+ new SFRest @@ -1028,7 +1036,7 @@Method List
-+ password SFRest @@ -1036,7 +1044,7 @@Method List
-+ #password SFRest::Connection @@ -1044,7 +1052,7 @@Method List
-+ #pause_all_tasks SFRest::Task @@ -1052,7 +1060,7 @@Method List
-+ #pause_task SFRest::Task @@ -1060,7 +1068,7 @@Method List
-+ #pause_update SFRest::Update @@ -1068,7 +1076,7 @@Method List
-+ #ping SFRest::Connection @@ -1076,7 +1084,7 @@Method List
-+ #post SFRest::Connection @@ -1084,7 +1092,7 @@Method List
-+ #process_theme_notification SFRest::Theme @@ -1092,7 +1100,7 @@Method List
-+ #profile_list SFRest::Profile @@ -1100,7 +1108,7 @@Method List
-+ #promote_to_admins SFRest::Group @@ -1108,7 +1116,7 @@Method List
-+ #protected_domains SFRest::Domains @@ -1116,7 +1124,7 @@Method List
-+ #put SFRest::Connection @@ -1124,7 +1132,7 @@Method List
-+ #regenerate_apikey SFRest::User @@ -1132,7 +1140,7 @@Method List
-+ #regenerate_apikeys SFRest::User @@ -1140,7 +1148,7 @@Method List
-+ #remove SFRest::Domains @@ -1148,7 +1156,7 @@Method List
-+ #remove_default_owner SFRest::Site_ownership @@ -1156,7 +1164,7 @@Method List
-+ #remove_members SFRest::Group @@ -1164,7 +1172,7 @@Method List
-+ #remove_sites SFRest::Collection @@ -1172,7 +1180,7 @@Method List
-+ #remove_sites SFRest::Group @@ -1180,7 +1188,7 @@Method List
-+ #rename_group SFRest::Group @@ -1188,7 +1196,7 @@Method List
-+ #reset_security_settings SFRest::Security_settings @@ -1196,7 +1204,7 @@Method List
-+ #reset_task_log_settings SFRest::Task_log_settings @@ -1204,7 +1212,7 @@Method List
-+ #reset_update_priority SFRest::Site_update_priority @@ -1212,7 +1220,7 @@Method List
-+ #resume_all_tasks SFRest::Task @@ -1220,7 +1228,7 @@Method List
-+ #resume_task SFRest::Task @@ -1228,7 +1236,7 @@Method List
-+ #resume_update SFRest::Update @@ -1236,7 +1244,7 @@Method List
-+ #role_data SFRest::Role @@ -1244,7 +1252,7 @@Method List
-+ #role_data_from_results SFRest::Role @@ -1252,7 +1260,7 @@Method List
-+ #role_list SFRest::Role @@ -1260,7 +1268,7 @@Method List
-+ #send_theme_notification SFRest::Theme @@ -1268,7 +1276,7 @@Method List
-+ #service_response SFRest::Connection @@ -1276,7 +1284,7 @@Method List
-+ #set_default SFRest::Profile @@ -1284,7 +1292,7 @@Method List
-+ #set_primary_site SFRest::Collection @@ -1292,7 +1300,7 @@Method List
-+ #set_variable SFRest::Variable @@ -1300,7 +1308,7 @@Method List
-+ #sfinfo SFRest::Info @@ -1308,7 +1316,7 @@Method List
-+ #site_data_from_results SFRest::Site @@ -1316,7 +1324,7 @@Method List
-+ #site_list SFRest::Site @@ -1324,7 +1332,7 @@Method List
-+ #sites SFRest::Group @@ -1332,7 +1340,7 @@Method List
-+ #stacks_with_details SFRest::Codebase @@ -1340,7 +1348,7 @@Method List
-+ #stage SFRest::Stage @@ -1348,7 +1356,7 @@Method List
-+ #staging_versions SFRest::Stage @@ -1356,7 +1364,7 @@Method List
-+ #start_update SFRest::Update @@ -1364,7 +1372,7 @@Method List
-+ #status SFRest::Domains @@ -1372,7 +1380,7 @@Method List
-+ #status_completed? SFRest::Task @@ -1380,7 +1388,7 @@Method List
-+ #status_done? SFRest::Task @@ -1388,7 +1396,7 @@Method List
-+ #status_error? SFRest::Task @@ -1396,7 +1404,7 @@Method List
-+ #status_info SFRest::Update @@ -1404,7 +1412,7 @@Method List
-+ #status_killed? SFRest::Task @@ -1412,7 +1420,7 @@Method List
-+ #status_not_started? SFRest::Task @@ -1420,7 +1428,7 @@Method List
-+ #status_running? SFRest::Task @@ -1428,7 +1436,7 @@Method List
-+ #task_completed? SFRest::Task @@ -1436,7 +1444,7 @@Method List
-+ #task_done? SFRest::Task @@ -1444,7 +1452,7 @@Method List
-+ #task_errored? SFRest::Task @@ -1452,7 +1460,7 @@Method List
-+ #task_killed? SFRest::Task @@ -1460,7 +1468,7 @@Method List
-+ #task_not_started? SFRest::Task @@ -1468,7 +1476,7 @@Method List
-+ #task_running? SFRest::Task @@ -1476,7 +1484,7 @@Method List
-+ #task_status SFRest::Task @@ -1484,7 +1492,7 @@Method List
-+ #terminate_task SFRest::Task @@ -1492,7 +1500,7 @@Method List
-+ #terminate_updater SFRest::Update @@ -1500,7 +1508,7 @@Method List
-+ #transfer_site_ownership_using_email SFRest::Site_ownership @@ -1508,7 +1516,7 @@Method List
-+ #transfer_site_ownership_using_username SFRest::Site_ownership @@ -1516,7 +1524,7 @@Method List
-+ #update SFRest::Update @@ -1524,7 +1532,7 @@Method List
-+ #update_list SFRest::Update @@ -1532,7 +1540,7 @@Method List
-+ #update_progress SFRest::Update @@ -1540,7 +1548,7 @@Method List
-+ #update_role SFRest::Role @@ -1548,7 +1556,7 @@Method List
-+ #update_user SFRest::User @@ -1556,7 +1564,7 @@Method List
-+ #update_version SFRest::Update @@ -1564,7 +1572,7 @@Method List
-+ user SFRest @@ -1572,7 +1580,7 @@Method List
-+ #user_data_from_results SFRest::User @@ -1580,7 +1588,7 @@Method List
-+ #user_list SFRest::User @@ -1588,7 +1596,7 @@Method List
-+ #username SFRest::Connection @@ -1596,7 +1604,7 @@Method List
-+ #v2_endpoint? SFRest::Update @@ -1604,7 +1612,7 @@Method List
-+ #validate_request SFRest::Update @@ -1612,7 +1620,7 @@Method List
-+ #variable_list SFRest::Variable @@ -1620,7 +1628,7 @@Method List
-+ #wait_until_done SFRest::Task @@ -1628,7 +1636,7 @@Method List
-+ #wait_until_state SFRest::Task diff --git a/doc/top-level-namespace.html b/doc/top-level-namespace.html index a039a9c..990a9e3 100644 --- a/doc/top-level-namespace.html +++ b/doc/top-level-namespace.html @@ -100,9 +100,9 @@Defined Under Namespace