Package com.atlan.model.assets

Class APIPath.APIPathBuilder<C extends APIPath,B extends APIPath.APIPathBuilder<C,B>>

java.lang.Object
com.atlan.model.core.AtlanObject.AtlanObjectBuilder<C,B>
com.atlan.model.relations.Reference.ReferenceBuilder<C,B>
com.atlan.model.assets.Asset.AssetBuilder<C,B>
com.atlan.model.assets.APIPath.APIPathBuilder<C,B>
Enclosing class:
APIPath
public abstract static class APIPath.APIPathBuilder<C extends APIPath,B extends APIPath.APIPathBuilder<C,B>> extends Asset.AssetBuilder<C,B>

  • Constructor Details

    • APIPathBuilder

      public APIPathBuilder()

  • Method Details

    • $fillValuesFrom

      protected B $fillValuesFrom(C instance)
      Overrides:
      $fillValuesFrom in class Asset.AssetBuilder<C extends APIPath,B extends APIPath.APIPathBuilder<C,B>>

    • typeName

      public B typeName(String typeName)
      Fixed typeName for APIPaths.
      Overrides:
      typeName in class Reference.ReferenceBuilder<C extends APIPath,B extends APIPath.APIPathBuilder<C,B>>
      Returns:
      this.

    • apiExternalDoc

      public B apiExternalDoc(String apiExternalDocKey, String apiExternalDocValue)

    • apiExternalDocs

      public B apiExternalDocs(Map<? extends String,? extends String> apiExternalDocs)

    • clearApiExternalDocs

      public B clearApiExternalDocs()

    • apiIsAuthOptional

      public B apiIsAuthOptional(Boolean apiIsAuthOptional)
      Whether authentication is optional (true) or required (false).
      Returns:
      this.

    • apiIsObjectReference

      public B apiIsObjectReference(Boolean apiIsObjectReference)
      If this asset refers to an APIObject
      Returns:
      this.

    • apiObjectQualifiedName

      public B apiObjectQualifiedName(String apiObjectQualifiedName)
      Qualified name of the APIObject that is referred to by this asset. When apiIsObjectReference is true.
      Returns:
      this.

    • apiPathAvailableOperation

      public B apiPathAvailableOperation(String apiPathAvailableOperation)

    • apiPathAvailableOperations

      public B apiPathAvailableOperations(Collection<? extends String> apiPathAvailableOperations)

    • clearApiPathAvailableOperations

      public B clearApiPathAvailableOperations()

    • apiPathAvailableResponseCode

      public B apiPathAvailableResponseCode(String apiPathAvailableResponseCodeKey, String apiPathAvailableResponseCodeValue)

    • apiPathAvailableResponseCodes

      public B apiPathAvailableResponseCodes(Map<? extends String,? extends String> apiPathAvailableResponseCodes)

    • clearApiPathAvailableResponseCodes

      public B clearApiPathAvailableResponseCodes()

    • apiPathIsIngressExposed

      public B apiPathIsIngressExposed(Boolean apiPathIsIngressExposed)
      Whether the path is exposed as an ingress (true) or not (false).
      Returns:
      this.

    • apiPathIsTemplated

      public B apiPathIsTemplated(Boolean apiPathIsTemplated)
      Whether the endpoint's path contains replaceable parameters (true) or not (false).
      Returns:
      this.

    • apiPathRawURI

      public B apiPathRawURI(String apiPathRawURI)
      Absolute path to an individual endpoint.
      Returns:
      this.

    • apiPathSummary

      public B apiPathSummary(String apiPathSummary)
      Descriptive summary intended to apply to all operations in this path.
      Returns:
      this.

    • apiSpec

      public B apiSpec(IAPISpec apiSpec)
      API specification in which this path exists.
      Returns:
      this.

    • apiSpecName

      public B apiSpecName(String apiSpecName)
      Simple name of the API spec, if this asset is contained in an API spec.
      Returns:
      this.

    • apiSpecQualifiedName

      public B apiSpecQualifiedName(String apiSpecQualifiedName)
      Unique name of the API spec, if this asset is contained in an API spec.
      Returns:
      this.

    • apiSpecType

      public B apiSpecType(String apiSpecType)
      Type of API, for example: OpenAPI, GraphQL, etc.
      Returns:
      this.

    • apiSpecVersion

      public B apiSpecVersion(String apiSpecVersion)
      Version of the API specification.
      Returns:
      this.

    • applicationContainer

      public B applicationContainer(IApplicationContainer applicationContainer)
      ApplicationContainer asset containing this Catalog asset.
      Returns:
      this.

    • assetApplicationQualifiedName

      public B assetApplicationQualifiedName(String assetApplicationQualifiedName)
      Qualified name of the Application Container that contains this asset.
      Returns:
      this.

    • inputToAirflowTask

      public B inputToAirflowTask(IAirflowTask inputToAirflowTask)

    • inputToAirflowTasks

      public B inputToAirflowTasks(Collection<? extends IAirflowTask> inputToAirflowTasks)

    • clearInputToAirflowTasks

      public B clearInputToAirflowTasks()

    • inputToProcess

      public B inputToProcess(ILineageProcess inputToProcess)

    • inputToProcesses

      public B inputToProcesses(Collection<? extends ILineageProcess> inputToProcesses)

    • clearInputToProcesses

      public B clearInputToProcesses()

    • inputToSparkJob

      public B inputToSparkJob(ISparkJob inputToSparkJob)

    • inputToSparkJobs

      public B inputToSparkJobs(Collection<? extends ISparkJob> inputToSparkJobs)

    • clearInputToSparkJobs

      public B clearInputToSparkJobs()

    • modelImplementedEntity

      public B modelImplementedEntity(IModelEntity modelImplementedEntity)

    • modelImplementedEntities

      public B modelImplementedEntities(Collection<? extends IModelEntity> modelImplementedEntities)

    • clearModelImplementedEntities

      public B clearModelImplementedEntities()

    • outputFromAirflowTask

      public B outputFromAirflowTask(IAirflowTask outputFromAirflowTask)

    • outputFromAirflowTasks

      public B outputFromAirflowTasks(Collection<? extends IAirflowTask> outputFromAirflowTasks)

    • clearOutputFromAirflowTasks

      public B clearOutputFromAirflowTasks()

    • outputFromProcess

      public B outputFromProcess(ILineageProcess outputFromProcess)

    • outputFromProcesses

      public B outputFromProcesses(Collection<? extends ILineageProcess> outputFromProcesses)

    • clearOutputFromProcesses

      public B clearOutputFromProcesses()

    • outputFromSparkJob

      public B outputFromSparkJob(ISparkJob outputFromSparkJob)

    • outputFromSparkJobs

      public B outputFromSparkJobs(Collection<? extends ISparkJob> outputFromSparkJobs)

    • clearOutputFromSparkJobs

      public B clearOutputFromSparkJobs()

    • self

      protected abstract B self()
      Specified by:
      self in class Asset.AssetBuilder<C extends APIPath,B extends APIPath.APIPathBuilder<C,B>>

    • build

      public abstract C build()
      Specified by:
      build in class Asset.AssetBuilder<C extends APIPath,B extends APIPath.APIPathBuilder<C,B>>

    • toString

      public String toString()
      Overrides:
      toString in class Asset.AssetBuilder<C extends APIPath,B extends APIPath.APIPathBuilder<C,B>>