Record Class OperationObject
java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.dataroutes.openapi.OperationObject
public record OperationObject(List<String> tags, String summary, String description, ExternalDocumentationObject externalDocs, List<ParameterObject> parameters, RequestBodyObject requestBody, ResponsesObject responses, boolean deprecated, boolean internal)
extends Record
A record object that represents an OpenAPI Operation Object.
An Operation Object describes a single API operation on a path. These are typically created by
route authors using the OpenApiOperationBuilder created using RouteGroup.RouteMounter.openApi(Consumer)
-
Constructor Summary
ConstructorsConstructorDescriptionOperationObject(List<String> tags, String summary, String description, ExternalDocumentationObject externalDocs, List<ParameterObject> parameters, RequestBodyObject requestBody, ResponsesObject responses, boolean deprecated, boolean internal) Creates an instance of aOperationObjectrecord class. -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturns the value of thedeprecatedrecord component.Returns the value of thedescriptionrecord component.final booleanIndicates whether some other object is "equal to" this one.Returns the value of theexternalDocsrecord component.final inthashCode()Returns a hash code value for this object.booleaninternal()Returns the value of theinternalrecord component.Returns the value of theparametersrecord component.Returns the value of therequestBodyrecord component.Returns the value of theresponsesrecord component.summary()Returns the value of thesummaryrecord component.tags()Returns the value of thetagsrecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
OperationObject
public OperationObject(List<String> tags, String summary, String description, ExternalDocumentationObject externalDocs, List<ParameterObject> parameters, RequestBodyObject requestBody, ResponsesObject responses, boolean deprecated, boolean internal) Creates an instance of aOperationObjectrecord class.- Parameters:
tags- the value for thetagsrecord componentsummary- the value for thesummaryrecord componentdescription- the value for thedescriptionrecord componentexternalDocs- the value for theexternalDocsrecord componentparameters- the value for theparametersrecord componentrequestBody- the value for therequestBodyrecord componentresponses- the value for theresponsesrecord componentdeprecated- the value for thedeprecatedrecord componentinternal- the value for theinternalrecord component
-
-
Method Details
-
toString
-
hashCode
-
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared withObjects::equals(Object,Object); primitive components are compared with thecomparemethod from their corresponding wrapper classes. -
tags
-
summary
Returns the value of thesummaryrecord component.- Returns:
- the value of the
summaryrecord component
-
description
Returns the value of thedescriptionrecord component.- Returns:
- the value of the
descriptionrecord component
-
externalDocs
Returns the value of theexternalDocsrecord component.- Returns:
- the value of the
externalDocsrecord component
-
parameters
Returns the value of theparametersrecord component.- Returns:
- the value of the
parametersrecord component
-
requestBody
Returns the value of therequestBodyrecord component.- Returns:
- the value of the
requestBodyrecord component
-
responses
Returns the value of theresponsesrecord component.- Returns:
- the value of the
responsesrecord component
-
deprecated
public boolean deprecated()Returns the value of thedeprecatedrecord component.- Returns:
- the value of the
deprecatedrecord component
-
internal
@SerializedName("x-internal") public boolean internal()Returns the value of theinternalrecord component.- Returns:
- the value of the
internalrecord component
-