docs/CromIAMEngineForJobManagerApi.md

In vjcitn/terraClientR: R Package Client for FireCloud

CromIAMEngineForJobManagerApi

All URIs are relative to http://localhost

Method | HTTP request | Description ------------- | ------------- | ------------- EngineVersionStatusGet | GET /engine/{version}/status | Returns the current health status of any monitored subsystems EngineVersionVersionGet | GET /engine/{version}/version | Returns the version of the Cromwell Engine

EngineVersionStatusGet

StatusResponse EngineVersionStatusGet(version)

Returns the current health status of any monitored subsystems

Example

library(openapi)

var.version <- 'v1' # character | API Version

#Returns the current health status of any monitored subsystems
api.instance <- CromIAMEngineForJobManagerApi$new()
# Configure OAuth2 access token for authorization: googleoauth
api.instance$apiClient$accessToken <- 'TODO_YOUR_ACCESS_TOKEN';
result <- api.instance$EngineVersionStatusGet(var.version)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- version | character| API Version | [default to 'v1']

Return type

StatusResponse

Authorization

googleoauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | All subsystems report an \"ok\" status | - | | 500 | At least one subsystem does not have an \"ok\" status | - |

EngineVersionVersionGet

VersionResponse EngineVersionVersionGet(version)

Returns the version of the Cromwell Engine

Example

library(openapi)

var.version <- 'v1' # character | API Version

#Returns the version of the Cromwell Engine
api.instance <- CromIAMEngineForJobManagerApi$new()
# Configure OAuth2 access token for authorization: googleoauth
api.instance$apiClient$accessToken <- 'TODO_YOUR_ACCESS_TOKEN';
result <- api.instance$EngineVersionVersionGet(var.version)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- version | character| API Version | [default to 'v1']

Return type

VersionResponse

Authorization

googleoauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Successful Request | - |

vjcitn/terraClientR documentation built on Dec. 23, 2021, 4:07 p.m.