Skip to content

JavaDocs correction for serverAction #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
olivergondza merged 1 commit into from
Sep 7, 2020
Merged

JavaDocs correction for serverAction #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions core/src/main/java/org/openstack4j/api/compute/ComputeService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
public interface ComputeService extends RestService {

/**
* Server Event Service API
* Server Actions Service API
*
* @return server event service
* @return server actions service
*/
ServerActionsService events();

Expand Down
8 changes: 4 additions & 4 deletions core/src/main/java/org/openstack4j/api/compute/ServerActionsService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import org.openstack4j.model.compute.ServerAction;

/**
* This interface defines all methods for the manipulation of events
* This interface defines all methods for the manipulation of server actions
*
* @author sujit sah
*
Expand All @@ -21,11 +21,11 @@ public interface ServerActionsService extends RestService {
List<? extends ServerAction> list(String serverId);

/**
* Gets a event of currently existing {@link ServerAction}s for a specified request id
* Gets the server action associated with specific request id for the specified server
*
* @param serverId the id of server
* @param requestId the request id of server
* @return the server event detail
* @param request id of specific action for the specified server
* @return the server action detail
*/
ServerAction show(String serverId, String requestId);

Expand Down
16 changes: 8 additions & 8 deletions core/src/main/java/org/openstack4j/model/compute/ServerAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,16 @@
*/
public interface ServerAction extends ModelEntity {
/**
* Returns the action of the event
* Returns the action performed on the server
*
* @return the action of the event
* @return the action performed on the server
*/
public String getAction();

/**
* Returns the list of event
* Returns the list of server actions
*
* @return the list of event
* @return the list of server actions
*/
public List<? extends ServerActionEvent> getEvents();

Expand All @@ -39,16 +39,16 @@ public interface ServerAction extends ModelEntity {
public String getInstaceUuid();

/**
* Returns the request id of the event
* Returns the request id of the server action
*
* @return the request id of the event
* @return the request id of the server action
*/
public String getRequestId();

/**
* Returns the start_time of the event
* Returns the start_time of the server action
*
* @return the start_time of the event
* @return the start_time of the server action
*/
public Date getStartTime();

Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/org/openstack4j/model/compute/builder/ServerActionEventBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import org.openstack4j.model.compute.ServerActionEvent;

/**
* Builder which create events
* Builder which create server action events
*
* @author sujit sah
*
Expand Down