Package io.github.primelib.webmethodsapigateway4j.spec

Klasse GetAPIOperationSpec

java.lang.Object
io.github.primelib.webmethodsapigateway4j.spec.GetAPIOperationSpec
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class GetAPIOperationSpec extends Object
GetAPISpec

Specification for the GetAPI operation.

  • Felddetails

    • VALIDATION_ENABLED

      @Experimental public static Boolean VALIDATION_ENABLED
      allows to disable validation of the spec, use with care!

  • Konstruktordetails

    • GetAPIOperationSpec

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

    • GetAPIOperationSpec

      @Internal public GetAPIOperationSpec(String apiId, String format, String url)
      Constructs a validated instance of GetAPIOperationSpec.

      NOTE: This constructor is not considered stable and may change if the operation is updated.

      Parameter:
      apiId - API Id for the API to be retrieved
      format - Output format of the API. If the value is 'swagger', you get a API definition in swagger format. If the value is 'raml', you get a raml document. If the value is 'openapi', you get a open API document. If the value is 'odata', you get a zip file holding the OData metadata and service document.
      url - User selected endpoint for API definition in swagger/raml format.

    • GetAPIOperationSpec

      protected GetAPIOperationSpec()

  • Methodendetails

    • validate

      public void validate()
      Validates the Spec, will throw a exception if required parameters are missing
      Löst aus:
      NullPointerException

    • builder

      public static GetAPIOperationSpec.GetAPIOperationSpecBuilder builder()

    • apiId

      @NotNull public @NotNull String apiId()
      API Id for the API to be retrieved

    • format

      @Nullable public @Nullable String format()
      Output format of the API. If the value is 'swagger', you get a API definition in swagger format. If the value is 'raml', you get a raml document. If the value is 'openapi', you get a open API document. If the value is 'odata', you get a zip file holding the OData metadata and service document.

    • url

      @Nullable public @Nullable String url()
      User selected endpoint for API definition in swagger/raml format.

    • apiId

      public GetAPIOperationSpec apiId(@NotNull @NotNull String apiId)
      API Id for the API to be retrieved
      Gibt zurück:
      this.

    • format

      public GetAPIOperationSpec format(@Nullable @Nullable String format)
      Output format of the API. If the value is 'swagger', you get a API definition in swagger format. If the value is 'raml', you get a raml document. If the value is 'openapi', you get a open API document. If the value is 'odata', you get a zip file holding the OData metadata and service document.
      Gibt zurück:
      this.

    • url

      public GetAPIOperationSpec url(@Nullable @Nullable String url)
      User selected endpoint for API definition in swagger/raml format.
      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