Package io.github.primelib.webmethodsapigateway4j.model

Klasse Operation

java.lang.Object
io.github.primelib.webmethodsapigateway4j.model.Operation
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class Operation extends Object
Operation

  • Felddetails

    • callbacks

      protected Map<String,Callback> callbacks
      An optional, string description, intended to apply to all operations in this path

    • deprecated

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

    • description

      protected String description
      A verbose explanation of the operation behavior

    • enabled

      protected Boolean enabled

    • externalDocs

      protected ExternalDocs externalDocs

    • mockedConditionsBasedCustomResponsesList

      protected List<MockedConditionsBasedCustomResponse> mockedConditionsBasedCustomResponsesList
      The list of mocked conditions and it's applicable only for mocked APIs

    • mockedResponses

      protected 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

    • operationId

      protected 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

    • parameters

      protected 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

    • requestBody

      protected RequestBody requestBody

    • responses

      protected Map<String,Response> responses
      The list of possible responses as they are returned from executing this operation

    • scopes

      protected List<String> scopes

    • summary

      protected String summary
      A short summary of what the operation does

    • tags

      protected 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

    • vendorExtensions

      protected Map<String,Object> vendorExtensions

  • Konstruktordetails

    • Operation

      public Operation(Consumer<Operation> spec)
      Constructs a validated instance of Operation.
      Parameter:
      spec - the specification to process

    • Operation

      @Internal public Operation(Map<String,Callback> callbacks, Boolean deprecated, String description, Boolean enabled, ExternalDocs externalDocs, List<MockedConditionsBasedCustomResponse> mockedConditionsBasedCustomResponsesList, Map<String,MockedResponse> mockedResponses, String operationId, List<Parameter> parameters, RequestBody requestBody, Map<String,Response> responses, List<String> scopes, String summary, List<String> tags, Map<String,Object> vendorExtensions)
      Constructs a validated instance of Operation.

      NOTE: This constructor is not considered stable and may change if the model is updated. Consider using Operation(Consumer) instead.

      Parameter:
      callbacks - An optional, string description, intended to apply to all operations in this path
      deprecated - Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false
      description - A verbose explanation of the operation behavior
      enabled - var.name
      externalDocs - var.name
      mockedConditionsBasedCustomResponsesList - The list of mocked conditions and it's applicable only for mocked APIs
      mockedResponses - The list of possible mocked responses as they are returned from executing this operation and it's applicable only for mocked APIs
      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
      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
      requestBody - var.name
      responses - The list of possible responses as they are returned from executing this operation
      scopes - var.name
      summary - A short summary of what the operation does
      tags - A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier
      vendorExtensions - var.name

    • Operation

      protected Operation()

  • Methodendetails

    • builder

      public static Operation.OperationBuilder builder()

    • callbacks

      public Map<String,Callback> callbacks()
      An optional, string description, intended to apply to all operations in this path

    • deprecated

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

    • description

      public String description()
      A verbose explanation of the operation behavior

    • enabled

      public Boolean enabled()

    • externalDocs

      public ExternalDocs externalDocs()

    • mockedConditionsBasedCustomResponsesList

      public List<MockedConditionsBasedCustomResponse> mockedConditionsBasedCustomResponsesList()
      The list of mocked conditions and it's applicable only for mocked APIs

    • mockedResponses

      public 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

    • operationId

      public 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

    • parameters

      public 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

    • requestBody

      public RequestBody requestBody()

    • responses

      public Map<String,Response> responses()
      The list of possible responses as they are returned from executing this operation

    • scopes

      public List<String> scopes()

    • summary

      public String summary()
      A short summary of what the operation does

    • tags

      public 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

    • vendorExtensions

      public Map<String,Object> vendorExtensions()

    • callbacks

      public Operation 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 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 description(String description)
      A verbose explanation of the operation behavior
      Gibt zurück:
      this.

    • enabled

      public Operation enabled(Boolean enabled)
      Gibt zurück:
      this.

    • externalDocs

      public Operation externalDocs(ExternalDocs externalDocs)
      Gibt zurück:
      this.

    • mockedConditionsBasedCustomResponsesList

      public Operation mockedConditionsBasedCustomResponsesList(List<MockedConditionsBasedCustomResponse> mockedConditionsBasedCustomResponsesList)
      The list of mocked conditions and it's applicable only for mocked APIs
      Gibt zurück:
      this.

    • mockedResponses

      public Operation 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 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 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 requestBody(RequestBody requestBody)
      Gibt zurück:
      this.

    • responses

      public Operation 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 scopes(List<String> scopes)
      Gibt zurück:
      this.

    • summary

      public Operation summary(String summary)
      A short summary of what the operation does
      Gibt zurück:
      this.

    • tags

      public Operation 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 vendorExtensions(Map<String,Object> vendorExtensions)
      Gibt zurück:
      this.

    • equals

      public boolean equals(Object o)
      Setzt außer Kraft:
      equals in Klasse Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Setzt außer Kraft:
      hashCode in Klasse Object

    • toString

      public String toString()
      Setzt außer Kraft:
      toString in Klasse Object