TaskGraphLogsApi: TaskGraphLogs operations

In TileDB-Inc/TileDB-Cloud-R: TileDB Cloud Platform R Client Package

TaskGraphLogs operations

Description

tiledbcloud.TaskGraphLogs

Format

An R6Class generator object

Methods

CreateTaskGraphLog Create a task graph log.

• @param namespace character

• @param log TaskGraphLog

• @returnType TaskGraphLog
  

• status code : 201 | The task graph was created. The returned TaskGraphLog will include the data the client sent, with the server-defined fields added in.

• return type : TaskGraphLog

• response headers :

• status code : 0 | error response

• return type : Error

• response headers :

GetTaskGraphLog Fetch information about a single task graph execution.

• @param namespace character

• @param id character

• @returnType TaskGraphLog
  

• status code : 200 | Information about the execution of a single task graph.

• return type : TaskGraphLog

• response headers :

• status code : 0 | error response

• return type : Error

• response headers :

ListTaskGraphLogs Fetch the task graph logs of a namespace the user has access to. The returned entries will include only summary data, and will not include information about the individual tasks that were executed. (This information is available when requesting an individual task graph log.) Entries in the response are ordered from newest to oldest. Pagination parameters work as in other API methods; see PaginationMetadata.

• @param namespace character

• @param created.by character

• @param search character

• @param start.time character

• @param end.time character

• @param page integer

• @param per.page integer

• @returnType TaskGraphLogsData
  

• status code : 200 | The task graph logs that matched the user's query.

• return type : TaskGraphLogsData

• response headers :

• status code : 0 | error response

• return type : Error

• response headers :

UpdateTaskGraphLog Update information about a single task graph execution.

• @param namespace character

• @param id character

• @param log TaskGraphLog

• status code : 204 | Log entry updated successfully.

• response headers :

• status code : 0 | error response

• return type : Error

• response headers :

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

• TaskGraphLogsApi$new()

• TaskGraphLogsApi$CreateTaskGraphLog()

• TaskGraphLogsApi$CreateTaskGraphLogWithHttpInfo()

• TaskGraphLogsApi$GetTaskGraphLog()

• TaskGraphLogsApi$GetTaskGraphLogWithHttpInfo()

• TaskGraphLogsApi$ListTaskGraphLogs()

• TaskGraphLogsApi$ListTaskGraphLogsWithHttpInfo()

• TaskGraphLogsApi$UpdateTaskGraphLog()

• TaskGraphLogsApi$UpdateTaskGraphLogWithHttpInfo()

• TaskGraphLogsApi$clone()

---

Method new()

Usage

TaskGraphLogsApi$new(apiClient)

---

Method CreateTaskGraphLog()

Usage

TaskGraphLogsApi$CreateTaskGraphLog(namespace, log, ...)

---

Method CreateTaskGraphLogWithHttpInfo()

Usage

TaskGraphLogsApi$CreateTaskGraphLogWithHttpInfo(namespace, log, ...)

---

Method GetTaskGraphLog()

Usage

TaskGraphLogsApi$GetTaskGraphLog(namespace, id, ...)

---

Method GetTaskGraphLogWithHttpInfo()

Usage

TaskGraphLogsApi$GetTaskGraphLogWithHttpInfo(namespace, id, ...)

---

Method ListTaskGraphLogs()

Usage

TaskGraphLogsApi$ListTaskGraphLogs(
  namespace = NULL,
  created.by = NULL,
  search = NULL,
  start.time = NULL,
  end.time = NULL,
  page = NULL,
  per.page = NULL,
  ...
)

---

Method ListTaskGraphLogsWithHttpInfo()

Usage

TaskGraphLogsApi$ListTaskGraphLogsWithHttpInfo(
  namespace = NULL,
  created.by = NULL,
  search = NULL,
  start.time = NULL,
  end.time = NULL,
  page = NULL,
  per.page = NULL,
  ...
)

---

Method UpdateTaskGraphLog()

Usage

TaskGraphLogsApi$UpdateTaskGraphLog(namespace, id, log, ...)

---

Method UpdateTaskGraphLogWithHttpInfo()

Usage

TaskGraphLogsApi$UpdateTaskGraphLogWithHttpInfo(namespace, id, log, ...)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

TaskGraphLogsApi$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
####################  CreateTaskGraphLog  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace that will own this task graph log.
var.log <- TaskGraphLog$new() # TaskGraphLog | 

api.instance <- TaskGraphLogsApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$CreateTaskGraphLog(var.namespace, var.log)


####################  GetTaskGraphLog  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace that owns this task graph log.
var.id <- 'id_example' # character | The UUID of the task graph log entry.

api.instance <- TaskGraphLogsApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetTaskGraphLog(var.namespace, var.id)


####################  ListTaskGraphLogs  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | Include logs for this namespace.
var.created.by <- 'created.by_example' # character | Include logs from only this user.
var.search <- 'search_example' # character | search string that will look at name.
var.start.time <- 'start.time_example' # character | Include logs created after this time.
var.end.time <- 'end.time_example' # character | Include logs created before this time.
var.page <- 56 # integer | pagination offset
var.per.page <- 56 # integer | pagination limit

api.instance <- TaskGraphLogsApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$ListTaskGraphLogs(namespace=var.namespace, created.by=var.created.by, search=var.search, start.time=var.start.time, end.time=var.end.time, page=var.page, per.page=var.per.page)


####################  UpdateTaskGraphLog  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace that owns this task graph log.
var.id <- 'id_example' # character | The UUID of the task graph log entry.
var.log <- TaskGraphLog$new() # TaskGraphLog | Updates to make to the task graph log. The only manual update that a client should need to make to a task graph log is to update its completion status to `succeeded`, `failed`, or `cancelled`. 

api.instance <- TaskGraphLogsApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$UpdateTaskGraphLog(var.namespace, var.id, var.log)



## End(Not run)

TileDB-Inc/TileDB-Cloud-R documentation built on July 18, 2024, 3:33 p.m.