Package io.github.coho04.githubapi.entities

Class GHStep

java.lang.Object

io.github.coho04.githubapi.bases.GHBase

io.github.coho04.githubapi.entities.GHStep

All Implemented Interfaces:

HttpRequestInterface, JSONHelper

public class GHStep
extends GHBase

Represents a GitHub Action workflow step. This class provides methods and properties to access information about a specific step in a GitHub Action workflow job.

Nested Class Summary

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

JSONHelper.JSONToObject<T>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
OffsetDateTime	getCompletedAt()	Returns the completion time of the step.
String	getConclusion()	Returns the conclusion of the step.
String	getName()	Returns the name of the step.
int	getNumber()	Returns the step number.
OffsetDateTime	getStartedAt()	Returns the start time of the step.
String	getStatus()	Returns the status of the step.

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

fetchArrayData, fetchArrayData, fetchPaginatedData, fetchPaginatedData, fetchPaginatedData, getBaseUrl, toJSONObject

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

GHStep

public GHStep(org.json.JSONObject jsonObject)

Constructs a new GHStep instance with the provided JSON object.

Parameters:

jsonObject - the JSON object containing the step data

Method Details

getName

public String getName()

Returns the name of the step.

Returns:

the name of the step

getNumber

public int getNumber()

Returns the step number.

Returns:

the step number

getStatus

public String getStatus()

Returns the status of the step.

Returns:

the status of the step

getCompletedAt

public OffsetDateTime getCompletedAt()

Returns the completion time of the step.

Returns:

the completion time of the step

getStartedAt

public OffsetDateTime getStartedAt()

Returns the start time of the step.

Returns:

the start time of the step

getConclusion

public String getConclusion()

Returns the conclusion of the step.

Returns:

the conclusion of the step