Package io.github.coho04.githubapi.entities

Class GHWorkflowJob

java.lang.Object

io.github.coho04.githubapi.bases.GHBase

io.github.coho04.githubapi.bases.ClassBase

io.github.coho04.githubapi.entities.GHWorkflowJob

All Implemented Interfaces:

HttpRequestInterface, JSONHelper

public class GHWorkflowJob
extends ClassBase

Represents a GitHub Workflow Job. This class provides methods and properties to access information about a workflow job in GitHub Actions.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.coho04.githubapi.interfaces.JSONHelper

JSONHelper.JSONToObject<T>

Constructor Summary

Constructors

Constructor	Description
GHWorkflowJob(org.json.JSONObject jsonObject)	Constructs a new GHWorkflowJob instance with the provided JSON object.

Method Summary

Modifier and Type	Method	Description
String	getCheckRunUrl()	Returns the URL for the check run associated with the workflow job.
OffsetDateTime	getCompletedAt()	Returns the completion time of the workflow job.
String	getConclusion()	Returns the conclusion of the workflow job.
String	getHeadBranch()	Returns the head branch of the workflow job.
String	getHeadSha()	Returns the head SHA of the workflow job.
List<String>	getLabels()	Returns the list of labels associated with the workflow job.
String	getName()	Returns the name of the workflow job.
int	getRunId()	Returns the run ID of the workflow job.
int	getRunnerGroupId()	Returns the runner group ID of the workflow job.
String	getRunnerGroupName()	Returns the runner group name of the workflow job.
int	getRunnerId()	Returns the runner ID of the workflow job.
String	getRunnerName()	Returns the runner name of the workflow job.
String	getRunUrl()	Returns the run URL of the workflow job.
OffsetDateTime	getStartedAt()	Returns the start time of the workflow job.
String	getStatus()	Returns the status of the workflow job.
List<GHStep>	getSteps()	Returns the list of steps in the workflow job.
String	getWorkflowName()	Returns the workflow name of the workflow job.

Methods inherited from class io.github.coho04.githubapi.bases.ClassBase

getEventsUrl, getHtmlUrl, getId, getNodeId, getUrl, toJSONObject

Methods inherited from class io.github.coho04.githubapi.bases.GHBase

fetchArrayData, fetchArrayData, fetchPaginatedData, fetchPaginatedData, fetchPaginatedData, getBaseUrl

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.coho04.githubapi.interfaces.HttpRequestInterface

extractNextPageUrl, sendDeleteRequest, sendDeleteRequestWithResponseCode, sendGetRequest, sendGetRequestWithLinkHeader, sendGetRequestWithResponseCode, sendPatchRequest, sendPostRequest, sendPutRequest

Methods inherited from interface io.github.coho04.githubapi.interfaces.JSONHelper

getArrayOrNull, getBooleanOrNull, getIntOrNull, getJSONArrayToStringList, getJSONObjectOrNull, getLocalDateOrNull, getLongOrNull, getStringOrNull

Constructor Details

GHWorkflowJob

public GHWorkflowJob(org.json.JSONObject jsonObject)

Constructs a new GHWorkflowJob instance with the provided JSON object.

Parameters:

jsonObject - the JSON object containing the workflow job data

Method Details

getName

public String getName()

Returns the name of the workflow job.

Returns:

the name of the workflow job

getStartedAt

public OffsetDateTime getStartedAt()

Returns the start time of the workflow job.

Returns:

the start time of the workflow job

getCompletedAt

public OffsetDateTime getCompletedAt()

Returns the completion time of the workflow job.

Returns:

the completion time of the workflow job

getStatus

public String getStatus()

Returns the status of the workflow job.

Returns:

the status of the workflow job

getConclusion

public String getConclusion()

Returns the conclusion of the workflow job.

Returns:

the conclusion of the workflow job

getHeadSha

public String getHeadSha()

Returns the head SHA of the workflow job.

Returns:

the head SHA of the workflow job

getHeadBranch

public String getHeadBranch()

Returns the head branch of the workflow job.

Returns:

the head branch of the workflow job

getRunId

public int getRunId()

Returns the run ID of the workflow job.

Returns:

the run ID of the workflow job

getRunnerGroupId

public int getRunnerGroupId()

Returns the runner group ID of the workflow job.

Returns:

the runner group ID of the workflow job

getSteps

public List<GHStep> getSteps()

Returns the list of steps in the workflow job.

Returns:

the list of steps

getRunnerId

public int getRunnerId()

Returns the runner ID of the workflow job.

Returns:

the runner ID of the workflow job

getLabels

public List<String> getLabels()

Returns the list of labels associated with the workflow job.

Returns:

the list of labels

getCheckRunUrl

public String getCheckRunUrl()

Returns the URL for the check run associated with the workflow job.

Returns:

the check run URL

getRunnerGroupName

public String getRunnerGroupName()

Returns the runner group name of the workflow job.

Returns:

the runner group name

getRunnerName

public String getRunnerName()

Returns the runner name of the workflow job.

Returns:

the runner name

getRunUrl

public String getRunUrl()

Returns the run URL of the workflow job.

Returns:

the run URL

getWorkflowName

public String getWorkflowName()

Returns the workflow name of the workflow job.

Returns:

the workflow name