Package io.github.primelib.webmethodsapigateway4j.model

Klasse Operation.OperationBuilder

java.lang.Object

io.github.primelib.webmethodsapigateway4j.model.Operation.OperationBuilder

Umschließende Klasse:

Operation

public static class Operation.OperationBuilder
extends Object

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
Operation	build()
Operation.OperationBuilder	callbacks(Map<String,Callback> callbacks)	An optional, string description, intended to apply to all operations in this path
Operation.OperationBuilder	deprecated(Boolean deprecated)	Declares this operation to be deprecated.
Operation.OperationBuilder	description(String description)	A verbose explanation of the operation behavior
Operation.OperationBuilder	enabled(Boolean enabled)
Operation.OperationBuilder	externalDocs(ExternalDocs externalDocs)
Operation.OperationBuilder	mockedConditionsBasedCustomResponsesList(List<MockedConditionsBasedCustomResponse> mockedConditionsBasedCustomResponsesList)	The list of mocked conditions and it's applicable only for mocked APIs
Operation.OperationBuilder	mockedResponses(Map<String,MockedResponse> mockedResponses)	The list of possible mocked responses as they are returned from executing this operation and it's applicable only for mocked APIs
Operation.OperationBuilder	operationId(String operationId)	Unique string used to identify the operation.
Operation.OperationBuilder	parameters(List<Parameter> parameters)	A list of parameters that are applicable for this operation.
Operation.OperationBuilder	requestBody(RequestBody requestBody)
Operation.OperationBuilder	responses(Map<String,Response> responses)	The list of possible responses as they are returned from executing this operation
Operation.OperationBuilder	scopes(List<String> scopes)
Operation.OperationBuilder	summary(String summary)	A short summary of what the operation does
Operation.OperationBuilder	tags(List<String> tags)	A list of tags for API documentation control.
String	toString()
Operation.OperationBuilder	vendorExtensions(Map<String,Object> vendorExtensions)

Von Klasse geerbte Methoden java.lang.Object

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

Methodendetails

callbacks

public Operation.OperationBuilder callbacks(Map<String,Callback> callbacks)

An optional, string description, intended to apply to all operations in this path

Gibt zurück:

this.

deprecated

public Operation.OperationBuilder deprecated(Boolean deprecated)

Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false

Gibt zurück:

this.

description

public Operation.OperationBuilder description(String description)

A verbose explanation of the operation behavior

Gibt zurück:

this.

enabled

public Operation.OperationBuilder enabled(Boolean enabled)

Gibt zurück:

this.

externalDocs

public Operation.OperationBuilder externalDocs(ExternalDocs externalDocs)

Gibt zurück:

this.

mockedConditionsBasedCustomResponsesList

public Operation.OperationBuilder mockedConditionsBasedCustomResponsesList(List<MockedConditionsBasedCustomResponse> mockedConditionsBasedCustomResponsesList)

The list of mocked conditions and it's applicable only for mocked APIs

Gibt zurück:

this.

mockedResponses

public Operation.OperationBuilder mockedResponses(Map<String,MockedResponse> mockedResponses)

The list of possible mocked responses as they are returned from executing this operation and it's applicable only for mocked APIs

Gibt zurück:

this.

operationId

public Operation.OperationBuilder operationId(String operationId)

Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive

Gibt zurück:

this.

parameters

public Operation.OperationBuilder parameters(List<Parameter> parameters)

A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it

Gibt zurück:

this.

requestBody

public Operation.OperationBuilder requestBody(RequestBody requestBody)

Gibt zurück:

this.

responses

public Operation.OperationBuilder responses(Map<String,Response> responses)

The list of possible responses as they are returned from executing this operation

Gibt zurück:

this.

scopes

public Operation.OperationBuilder scopes(List<String> scopes)

Gibt zurück:

this.

summary

public Operation.OperationBuilder summary(String summary)

A short summary of what the operation does

Gibt zurück:

this.

tags

public Operation.OperationBuilder tags(List<String> tags)

A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier

Gibt zurück:

this.

vendorExtensions

public Operation.OperationBuilder vendorExtensions(Map<String,Object> vendorExtensions)

Gibt zurück:

this.

build

public Operation build()

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object