Class ApiInstanceMetaData

java.lang.Object
com.kingsrook.qqq.api.model.metadata.ApiInstanceMetaData
All Implemented Interfaces:
ApiOperation.EnabledOperationsProvider
public class ApiInstanceMetaData extends Object implements ApiOperation.EnabledOperationsProvider

  • Constructor Details

    • ApiInstanceMetaData

      public ApiInstanceMetaData()

  • Method Details

    • validate

      public void validate(String apiName, QInstance qInstance, QInstanceValidator validator)

    • getCurrentVersion

      public APIVersion getCurrentVersion()
      Getter for currentVersion

    • setCurrentVersion

      public void setCurrentVersion(APIVersion currentVersion)
      Setter for currentVersion

    • withCurrentVersion

      public ApiInstanceMetaData withCurrentVersion(APIVersion currentVersion)
      Fluent setter for currentVersion

    • getPastVersions

      public List<APIVersion> getPastVersions()
      Getter for pastVersions

    • setPastVersions

      public void setPastVersions(List<APIVersion> pastVersions)
      Setter for pastVersions

    • withPastVersions

      public ApiInstanceMetaData withPastVersions(List<APIVersion> pastVersions)
      Fluent setter for pastVersions

    • getFutureVersions

      public List<APIVersion> getFutureVersions()
      Getter for futureVersions

    • setFutureVersions

      public void setFutureVersions(List<APIVersion> futureVersions)
      Setter for futureVersions

    • withFutureVersions

      public ApiInstanceMetaData withFutureVersions(List<APIVersion> futureVersions)
      Fluent setter for futureVersions

    • getSupportedVersions

      public List<APIVersion> getSupportedVersions()
      Getter for supportedVersions

    • setSupportedVersions

      public void setSupportedVersions(List<APIVersion> supportedVersions)
      Setter for supportedVersions

    • withSupportedVersions

      public ApiInstanceMetaData withSupportedVersions(List<APIVersion> supportedVersions)
      Fluent setter for supportedVersions

    • getName

      public String getName()
      Getter for name

    • setName

      public void setName(String name)
      Setter for name

    • withName

      public ApiInstanceMetaData withName(String name)
      Fluent setter for name

    • getDescription

      public String getDescription()
      Getter for description

    • setDescription

      public void setDescription(String description)
      Setter for description

    • withDescription

      public ApiInstanceMetaData withDescription(String description)
      Fluent setter for description

    • getContactEmail

      public String getContactEmail()
      Getter for contactEmail

    • setContactEmail

      public void setContactEmail(String contactEmail)
      Setter for contactEmail

    • withContactEmail

      public ApiInstanceMetaData withContactEmail(String contactEmail)
      Fluent setter for contactEmail

    • getIncludeErrorTooManyRequests

      public boolean getIncludeErrorTooManyRequests()
      Getter for includeErrorTooManyRequests

    • setIncludeErrorTooManyRequests

      public void setIncludeErrorTooManyRequests(boolean includeErrorTooManyRequests)
      Setter for includeErrorTooManyRequests

    • withIncludeErrorTooManyRequests

      public ApiInstanceMetaData withIncludeErrorTooManyRequests(boolean includeErrorTooManyRequests)
      Fluent setter for includeErrorTooManyRequests

    • getServers

      public List<Server> getServers()
      Getter for servers

    • setServers

      public void setServers(List<Server> servers)
      Setter for servers

    • withServers

      public ApiInstanceMetaData withServers(List<Server> servers)
      Fluent setter for servers

    • getLabel

      public String getLabel()
      Getter for label

    • setLabel

      public void setLabel(String label)
      Setter for label

    • withLabel

      public ApiInstanceMetaData withLabel(String label)
      Fluent setter for label

    • getPath

      public String getPath()
      Getter for path

    • setPath

      public void setPath(String path)
      Setter for path

    • withPath

      public ApiInstanceMetaData withPath(String path)
      Fluent setter for path

    • getEnabledOperations

      public Set<ApiOperation> getEnabledOperations()
      Specified by:
      getEnabledOperations in interface ApiOperation.EnabledOperationsProvider

    • getDisabledOperations

      public Set<ApiOperation> getDisabledOperations()
      Specified by:
      getDisabledOperations in interface ApiOperation.EnabledOperationsProvider

    • setEnabledOperations

      public void setEnabledOperations(Set<ApiOperation> enabledOperations)
      Setter for enabledOperations

    • withEnabledOperations

      public ApiInstanceMetaData withEnabledOperations(Set<ApiOperation> enabledOperations)
      Fluent setter for enabledOperations

    • withEnabledOperation

      public ApiInstanceMetaData withEnabledOperation(ApiOperation operation)
      Fluent setter for enabledOperations

    • withEnabledOperations

      public ApiInstanceMetaData withEnabledOperations(ApiOperation... operations)
      Fluent setter for enabledOperations

    • setDisabledOperations

      public void setDisabledOperations(Set<ApiOperation> disabledOperations)
      Setter for disabledOperations

    • withDisabledOperations

      public ApiInstanceMetaData withDisabledOperations(Set<ApiOperation> disabledOperations)
      Fluent setter for disabledOperations

    • withDisabledOperation

      public ApiInstanceMetaData withDisabledOperation(ApiOperation operation)
      Fluent setter for disabledOperations

    • withDisabledOperations

      public ApiInstanceMetaData withDisabledOperations(ApiOperation... operations)
      Fluent setter for disabledOperations

    • getSecuritySchemes

      public Map<String,SecurityScheme> getSecuritySchemes()
      Getter for securitySchemes

    • setSecuritySchemes

      public void setSecuritySchemes(Map<String,SecurityScheme> securitySchemes)
      Setter for securitySchemes

    • withSecuritySchemes

      public ApiInstanceMetaData withSecuritySchemes(Map<String,SecurityScheme> securitySchemes)
      Fluent setter for securitySchemes

    • withSecurityScheme

      public ApiInstanceMetaData withSecurityScheme(String label, SecurityScheme securityScheme)
      Fluent setter for securitySchemes