Package org.forgerock.api.models

Class Action.Builder

java.lang.Object

org.forgerock.api.models.Operation.Builder<Action.Builder>

org.forgerock.api.models.Action.Builder

Enclosing class:

Action

public static final class Action.Builder
extends Operation.Builder<Action.Builder>

Builder class for creating the Action.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Action	build()	Builds the Action instance.
Action.Builder	name(String name)	Set the Id.
Action.Builder	request(Schema request)	Set the request.
Action.Builder	response(Schema response)	Set the response.
protected Action.Builder	self()	Abstract method that returns the instantiated Builder itself.

Methods inherited from class org.forgerock.api.models.Operation.Builder

description, description, detailsFromAnnotation, error, errors, parameter, parameters, stability, supportedLocales

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

self

protected Action.Builder self()

Description copied from class: Operation.Builder

Abstract method that returns the instantiated Builder itself.

Specified by:

self in class Operation.Builder<Action.Builder>

Returns:

Builder

name

public Action.Builder name(String name)

Set the Id.

Parameters:

name - Action name

Returns:

Builder

request

public Action.Builder request(Schema request)

Set the request.

Parameters:

request - Action request

Returns:

Builder

response

public Action.Builder response(Schema response)

Set the response.

Parameters:

response - Action resopnse

Returns:

Builder

build

public Action build()

Builds the Action instance.

Returns:

Action instance