Package com.arc_e_tect.gradle.apionly.transcriberj

Interface GenerateContractSourcesAction.Parameters

All Superinterfaces:
org.gradle.workers.WorkParameters
Enclosing class:
GenerateContractSourcesAction
public static interface GenerateContractSourcesAction.Parameters extends org.gradle.workers.WorkParameters
What the task hands over.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.workers.WorkParameters

    org.gradle.workers.WorkParameters.None

  • Method Summary

    Modifier and Type
    Method
    Description
    org.gradle.api.file.ConfigurableFileCollection
    getAsyncContract()
    The contract's AsyncAPI document, or nothing when it has none.
    org.gradle.api.provider.Property<String>
    getBasePackage()
    The base package.
    org.gradle.api.file.RegularFileProperty
    getContract()
    The fetched contract document.
    org.gradle.api.provider.Property<String>
    getContractName()
    The contract's name.
    org.gradle.api.provider.Property<String>
    getContractSha256()
    The locked hash.
    org.gradle.api.provider.Property<String>
    getContractVersion()
    The locked version.
    org.gradle.api.provider.Property<String>
    getDescriptionBundle()
    The base name of the bundle descriptions resolve through, or absent when the project supplies none.
    org.gradle.api.provider.Property<String>
    getDescriptionPlaceholder()
    The description placeholder.
    org.gradle.api.provider.MapProperty<String,Map<String,String>>
    getEmitterOptions()
    The options of each emitter, by emitter id.
    org.gradle.api.file.RegularFileProperty
    getEndpointIndex()
    Where the endpoint index goes.
    org.gradle.api.provider.Property<Boolean>
    getGenerateDocs()
    Whether descriptions come from the contract.
    org.gradle.api.provider.Property<String>
    getInvalidRequestStatus()
    The status that means "the request is invalid".
    org.gradle.api.file.DirectoryProperty
    getOutputDirectory()
    Where the sources go.
    org.gradle.api.provider.Property<Integer>
    getRecursionDepth()
    The recursion depth.
    org.gradle.api.file.RegularFileProperty
    getReportFile()
    Where the report goes.
    org.gradle.api.file.DirectoryProperty
    getResourceDirectory()
    Where a resource an emitter writes goes.
    org.gradle.api.provider.Property<Boolean>
    getStrictRequests()
    Whether an undeclared additionalProperties forbids unknown members.
    org.gradle.api.provider.ListProperty<String>
    getValidateFormats()
    The formats an invalid-request case is derived for.
    org.gradle.api.file.RegularFileProperty
    getValidValuesReport()
    Where the machine-readable report of every generated valid value goes; nothing is written when it is not set.

  • Method Details

    • getContract

      org.gradle.api.file.RegularFileProperty getContract()
      The fetched contract document.
      Returns:
      the document

    • getAsyncContract

      org.gradle.api.file.ConfigurableFileCollection getAsyncContract()
      The contract's AsyncAPI document, or nothing when it has none.
      Returns:
      the document

    • getContractVersion

      org.gradle.api.provider.Property<String> getContractVersion()
      The locked version.
      Returns:
      the version

    • getContractSha256

      org.gradle.api.provider.Property<String> getContractSha256()
      The locked hash.
      Returns:
      the hash

    • getContractName

      org.gradle.api.provider.Property<String> getContractName()
      The contract's name.
      Returns:
      the name

    • getBasePackage

      org.gradle.api.provider.Property<String> getBasePackage()
      The base package.
      Returns:
      the package

    • getRecursionDepth

      org.gradle.api.provider.Property<Integer> getRecursionDepth()
      The recursion depth.
      Returns:
      the depth

    • getGenerateDocs

      org.gradle.api.provider.Property<Boolean> getGenerateDocs()
      Whether descriptions come from the contract.
      Returns:
      the setting

    • getDescriptionPlaceholder

      org.gradle.api.provider.Property<String> getDescriptionPlaceholder()
      The description placeholder.
      Returns:
      the placeholder

    • getDescriptionBundle

      org.gradle.api.provider.Property<String> getDescriptionBundle()
      The base name of the bundle descriptions resolve through, or absent when the project supplies none.
      Returns:
      the bundle's base name

    • getInvalidRequestStatus

      org.gradle.api.provider.Property<String> getInvalidRequestStatus()
      The status that means "the request is invalid".
      Returns:
      the status

    • getStrictRequests

      org.gradle.api.provider.Property<Boolean> getStrictRequests()
      Whether an undeclared additionalProperties forbids unknown members.
      Returns:
      the setting

    • getValidateFormats

      org.gradle.api.provider.ListProperty<String> getValidateFormats()
      The formats an invalid-request case is derived for.
      Returns:
      the format names

    • getEmitterOptions

      org.gradle.api.provider.MapProperty<String,Map<String,String>> getEmitterOptions()
      The options of each emitter, by emitter id.
      Returns:
      the options

    • getOutputDirectory

      org.gradle.api.file.DirectoryProperty getOutputDirectory()
      Where the sources go.
      Returns:
      the directory

    • getResourceDirectory

      org.gradle.api.file.DirectoryProperty getResourceDirectory()
      Where a resource an emitter writes goes.
      Returns:
      the directory

    • getEndpointIndex

      org.gradle.api.file.RegularFileProperty getEndpointIndex()
      Where the endpoint index goes.
      Returns:
      the index

    • getReportFile

      org.gradle.api.file.RegularFileProperty getReportFile()
      Where the report goes.
      Returns:
      the report

    • getValidValuesReport

      org.gradle.api.file.RegularFileProperty getValidValuesReport()
      Where the machine-readable report of every generated valid value goes; nothing is written when it is not set.
      Returns:
      the report