Package io.vertigo.studio.notebook.webservices

Class WebServiceSketch

java.lang.Object

io.vertigo.studio.notebook.AbstractSketch

io.vertigo.studio.notebook.webservices.WebServiceSketch

All Implemented Interfaces:

Sketch

public final class WebServiceSketch
extends AbstractSketch

Web service Sketch.

Author:

npiedeloup

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WebServiceSketch.Verb	HTTP Verb supported.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX

Fields inherited from interface io.vertigo.studio.notebook.Sketch

REGEX_SKETCH_NAME

Constructor Summary

Constructors

Constructor	Description
WebServiceSketch(String name, WebServiceSketch.Verb verb, String path, List<WebServiceSketchParam> webServiceParams, Optional<WebServiceSketchResponseContent> webServiceResponseContentOpt, String moduleName, Optional<String> groupNameOpt, String humanReadableAction, String doc)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getDoc()
Optional<String>	getGroupNameOpt()
String	getHumanReadableAction()
String	getModuleName()
String	getPath()
WebServiceSketch.Verb	getVerb()
List<WebServiceSketchParam>	getWebServiceParams()
Optional<WebServiceSketchResponseContent>	getWebServiceResponseContentOpt()

Methods inherited from class io.vertigo.studio.notebook.AbstractSketch

getKey, getLocalName, toString

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

See Also:

• Constant Field Values

Constructor Details

WebServiceSketch

public WebServiceSketch(String name,
 WebServiceSketch.Verb verb,
 String path,
 List<WebServiceSketchParam> webServiceParams,
 Optional<WebServiceSketchResponseContent> webServiceResponseContentOpt,
 String moduleName,
 Optional<String> groupNameOpt,
 String humanReadableAction,
 String doc)

Constructor.

Method Details

getPath

public String getPath()

Returns:

path

getVerb

public WebServiceSketch.Verb getVerb()

Returns:

verb

getWebServiceParams

public List<WebServiceSketchParam> getWebServiceParams()

Returns:

webServiceParams

getWebServiceResponseContentOpt

public Optional<WebServiceSketchResponseContent> getWebServiceResponseContentOpt()

getModuleName

public String getModuleName()

getGroupNameOpt

public Optional<String> getGroupNameOpt()

getHumanReadableAction

public String getHumanReadableAction()

getDoc

public String getDoc()

Returns:

doc