io.digdag.client

Class DigdagClient

java.lang.Object

io.digdag.client.DigdagClient

All Implemented Interfaces:

java.lang.AutoCloseable

public class DigdagClient
extends java.lang.Object
implements java.lang.AutoCloseable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DigdagClient.Builder

Method Summary

Modifier and Type	Method and Description
Config	adminGetAttemptUserInfo(Id attemptId)
RestSessionAttemptCollection	backfillSchedule(Id scheduleId, java.time.Instant fromTime, java.lang.String attemptName, com.google.common.base.Optional<java.lang.Integer> count, boolean dryRun)
static DigdagClient.Builder	builder()
RestVersionCheckResult	checkClientVersion(java.lang.String clientVersion)
void	close()
void	deleteProject(Id projId)
void	deleteProjectSecret(Id projectId, java.lang.String key)
RestScheduleSummary	disableSchedule(Id scheduleId)
RestScheduleSummary	enableSchedule(Id scheduleId)
RestScheduleSummary	enableSchedule(Id scheduleId, boolean skipSchedule, com.google.common.base.Optional<java.lang.String> nextTime)
java.io.InputStream	getLogFile(Id attemptId, RestLogFileHandle handle)
java.io.InputStream	getLogFile(Id attemptId, java.lang.String fileName)
RestLogFileHandleCollection	getLogFileHandlesOfAttempt(Id attemptId)
RestLogFileHandleCollection	getLogFileHandlesOfTask(Id attemptId, java.lang.String taskName)
RestProject	getProject(Id projId)
RestProject	getProject(java.lang.String name)
java.io.InputStream	getProjectArchive(Id projId, java.lang.String revision)
RestProjectCollection	getProjects()
RestRevisionCollection	getRevisions(Id projId, com.google.common.base.Optional<Id> lastId)
RestSchedule	getSchedule(Id id)
RestSchedule	getSchedule(Id projectId, java.lang.String workflowName)
RestScheduleCollection	getSchedules()
RestScheduleCollection	getSchedules(Id projectId, com.google.common.base.Optional<Id> lastId)
RestScheduleCollection	getSchedules(com.google.common.base.Optional<Id> lastId)
RestSession	getSession(Id sessionId)
RestSessionAttempt	getSessionAttempt(Id attemptId)
RestSessionAttemptCollection	getSessionAttemptRetries(Id attemptId)
RestSessionAttemptCollection	getSessionAttempts(Id sessionId, com.google.common.base.Optional<Id> lastId, com.google.common.base.Optional<java.lang.Integer> pageSize)
RestSessionAttemptCollection	getSessionAttempts(com.google.common.base.Optional<Id> lastId, com.google.common.base.Optional<java.lang.Integer> pageSize)
RestSessionAttemptCollection	getSessionAttempts(java.lang.String projName, com.google.common.base.Optional<Id> lastId)
RestSessionAttemptCollection	getSessionAttempts(java.lang.String projName, java.lang.String workflowName, com.google.common.base.Optional<Id> lastId)
RestSessionCollection	getSessions()
RestSessionCollection	getSessions(Id projectId)
RestSessionCollection	getSessions(Id projectId, com.google.common.base.Optional<Id> lastId, com.google.common.base.Optional<java.lang.Integer> pageSize)
RestSessionCollection	getSessions(Id projectId, java.lang.String workflowName)
RestSessionCollection	getSessions(Id projectId, java.lang.String workflowName, com.google.common.base.Optional<Id> lastId, com.google.common.base.Optional<java.lang.Integer> pageSize)
RestSessionCollection	getSessions(com.google.common.base.Optional<Id> lastId)
RestTaskCollection	getTasks(Id attemptId)
java.util.Map<java.lang.String,java.lang.Object>	getVersion()
RestWorkflowDefinition	getWorkflowDefinition(Id workflowId)
RestWorkflowDefinition	getWorkflowDefinition(Id projId, java.lang.String name)
RestWorkflowDefinition	getWorkflowDefinition(Id projId, java.lang.String name, java.lang.String revision)
RestWorkflowDefinitionCollection	getWorkflowDefinitions()
RestWorkflowDefinitionCollection	getWorkflowDefinitions(Id projId)
RestWorkflowDefinitionCollection	getWorkflowDefinitions(Id projId, java.lang.String revision)
RestWorkflowDefinitionCollection	getWorkflowDefinitions(com.google.common.base.Optional<Id> lastId)
RestWorkflowSessionTime	getWorkflowTruncatedSessionTime(Id workflowId, LocalTimeOrInstant time)
RestWorkflowSessionTime	getWorkflowTruncatedSessionTime(Id workflowId, LocalTimeOrInstant time, SessionTimeTruncate mode)
void	killSessionAttempt(Id attemptId)
RestSecretList	listProjectSecrets(Id projectId)
Config	newConfig()
static com.fasterxml.jackson.databind.ObjectMapper	objectMapper()
RestProject	putProjectRevision(java.lang.String projName, java.lang.String revision, java.io.File body)
RestProject	putProjectRevision(java.lang.String projName, java.lang.String revision, java.io.File body, com.google.common.base.Optional<java.time.Instant> scheduleFrom)
void	setProjectSecret(Id projectId, java.lang.String key, java.lang.String value)
RestScheduleSummary	skipSchedulesByCount(Id scheduleId, java.time.Instant fromTime, int count, com.google.common.base.Optional<java.time.Instant> runTime, boolean dryRun)
RestScheduleSummary	skipSchedulesToTime(Id scheduleId, java.time.Instant untilTime, com.google.common.base.Optional<java.time.Instant> runTime, boolean dryRun)
RestScheduleSummary	skipSchedulesToTime(Id scheduleId, java.time.LocalDateTime untilTime, com.google.common.base.Optional<java.time.Instant> runTime, boolean dryRun)
RestSessionAttempt	startSessionAttempt(RestSessionAttemptRequest request)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

objectMapper

public static com.fasterxml.jackson.databind.ObjectMapper objectMapper()

builder

public static DigdagClient.Builder builder()

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

newConfig

public Config newConfig()

getProject

public RestProject getProject(java.lang.String name)

getProjects

public RestProjectCollection getProjects()

getProject

public RestProject getProject(Id projId)

deleteProject

public void deleteProject(Id projId)

getRevisions

public RestRevisionCollection getRevisions(Id projId,
                                           com.google.common.base.Optional<Id> lastId)

getWorkflowDefinitions

public RestWorkflowDefinitionCollection getWorkflowDefinitions()

getWorkflowDefinitions

public RestWorkflowDefinitionCollection getWorkflowDefinitions(com.google.common.base.Optional<Id> lastId)

getWorkflowDefinitions

public RestWorkflowDefinitionCollection getWorkflowDefinitions(Id projId)

getWorkflowDefinitions

public RestWorkflowDefinitionCollection getWorkflowDefinitions(Id projId,
                                                               java.lang.String revision)

getWorkflowDefinition

public RestWorkflowDefinition getWorkflowDefinition(Id projId,
                                                    java.lang.String name)

getWorkflowDefinition

public RestWorkflowDefinition getWorkflowDefinition(Id projId,
                                                    java.lang.String name,
                                                    java.lang.String revision)

getWorkflowDefinition

public RestWorkflowDefinition getWorkflowDefinition(Id workflowId)

getWorkflowTruncatedSessionTime

public RestWorkflowSessionTime getWorkflowTruncatedSessionTime(Id workflowId,
                                                               LocalTimeOrInstant time)

getWorkflowTruncatedSessionTime

public RestWorkflowSessionTime getWorkflowTruncatedSessionTime(Id workflowId,
                                                               LocalTimeOrInstant time,
                                                               SessionTimeTruncate mode)

putProjectRevision

public RestProject putProjectRevision(java.lang.String projName,
                                      java.lang.String revision,
                                      java.io.File body)
                               throws java.io.IOException

Throws:

java.io.IOException

putProjectRevision

public RestProject putProjectRevision(java.lang.String projName,
                                      java.lang.String revision,
                                      java.io.File body,
                                      com.google.common.base.Optional<java.time.Instant> scheduleFrom)
                               throws java.io.IOException

Throws:

java.io.IOException

getProjectArchive

public java.io.InputStream getProjectArchive(Id projId,
                                             java.lang.String revision)

getSchedules

public RestScheduleCollection getSchedules()

getSchedules

public RestScheduleCollection getSchedules(com.google.common.base.Optional<Id> lastId)

getSchedules

public RestScheduleCollection getSchedules(Id projectId,
                                           com.google.common.base.Optional<Id> lastId)

getSchedule

public RestSchedule getSchedule(Id projectId,
                                java.lang.String workflowName)

getSchedule

public RestSchedule getSchedule(Id id)

getSessions

public RestSessionCollection getSessions()

getSessions

public RestSessionCollection getSessions(com.google.common.base.Optional<Id> lastId)

getSessions

public RestSessionCollection getSessions(Id projectId)

getSessions

public RestSessionCollection getSessions(Id projectId,
                                         com.google.common.base.Optional<Id> lastId,
                                         com.google.common.base.Optional<java.lang.Integer> pageSize)

getSessions

public RestSessionCollection getSessions(Id projectId,
                                         java.lang.String workflowName)

getSessions

public RestSessionCollection getSessions(Id projectId,
                                         java.lang.String workflowName,
                                         com.google.common.base.Optional<Id> lastId,
                                         com.google.common.base.Optional<java.lang.Integer> pageSize)

getSession

public RestSession getSession(Id sessionId)

getSessionAttempts

public RestSessionAttemptCollection getSessionAttempts(Id sessionId,
                                                       com.google.common.base.Optional<Id> lastId,
                                                       com.google.common.base.Optional<java.lang.Integer> pageSize)

getSessionAttempts

public RestSessionAttemptCollection getSessionAttempts(com.google.common.base.Optional<Id> lastId,
                                                       com.google.common.base.Optional<java.lang.Integer> pageSize)

getSessionAttempts

public RestSessionAttemptCollection getSessionAttempts(java.lang.String projName,
                                                       com.google.common.base.Optional<Id> lastId)

getSessionAttempts

public RestSessionAttemptCollection getSessionAttempts(java.lang.String projName,
                                                       java.lang.String workflowName,
                                                       com.google.common.base.Optional<Id> lastId)

getSessionAttempt

public RestSessionAttempt getSessionAttempt(Id attemptId)

getSessionAttemptRetries

public RestSessionAttemptCollection getSessionAttemptRetries(Id attemptId)

getTasks

public RestTaskCollection getTasks(Id attemptId)

getLogFileHandlesOfAttempt

public RestLogFileHandleCollection getLogFileHandlesOfAttempt(Id attemptId)

getLogFileHandlesOfTask

public RestLogFileHandleCollection getLogFileHandlesOfTask(Id attemptId,
                                                           java.lang.String taskName)

getLogFile

public java.io.InputStream getLogFile(Id attemptId,
                                      RestLogFileHandle handle)

getLogFile

public java.io.InputStream getLogFile(Id attemptId,
                                      java.lang.String fileName)

startSessionAttempt

public RestSessionAttempt startSessionAttempt(RestSessionAttemptRequest request)

killSessionAttempt

public void killSessionAttempt(Id attemptId)

skipSchedulesToTime

public RestScheduleSummary skipSchedulesToTime(Id scheduleId,
                                               java.time.Instant untilTime,
                                               com.google.common.base.Optional<java.time.Instant> runTime,
                                               boolean dryRun)

skipSchedulesToTime

public RestScheduleSummary skipSchedulesToTime(Id scheduleId,
                                               java.time.LocalDateTime untilTime,
                                               com.google.common.base.Optional<java.time.Instant> runTime,
                                               boolean dryRun)

skipSchedulesByCount

public RestScheduleSummary skipSchedulesByCount(Id scheduleId,
                                                java.time.Instant fromTime,
                                                int count,
                                                com.google.common.base.Optional<java.time.Instant> runTime,
                                                boolean dryRun)

backfillSchedule

public RestSessionAttemptCollection backfillSchedule(Id scheduleId,
                                                     java.time.Instant fromTime,
                                                     java.lang.String attemptName,
                                                     com.google.common.base.Optional<java.lang.Integer> count,
                                                     boolean dryRun)

disableSchedule

public RestScheduleSummary disableSchedule(Id scheduleId)

enableSchedule

public RestScheduleSummary enableSchedule(Id scheduleId)

enableSchedule

public RestScheduleSummary enableSchedule(Id scheduleId,
                                          boolean skipSchedule,
                                          com.google.common.base.Optional<java.lang.String> nextTime)

getVersion

public java.util.Map<java.lang.String,java.lang.Object> getVersion()

checkClientVersion

public RestVersionCheckResult checkClientVersion(java.lang.String clientVersion)

setProjectSecret

public void setProjectSecret(Id projectId,
                             java.lang.String key,
                             java.lang.String value)

deleteProjectSecret

public void deleteProjectSecret(Id projectId,
                                java.lang.String key)

listProjectSecrets

public RestSecretList listProjectSecrets(Id projectId)

adminGetAttemptUserInfo

public Config adminGetAttemptUserInfo(Id attemptId)