Package com.atlan.api

Class TypeDefsEndpoint

java.lang.Object
com.atlan.api.AbstractEndpoint
com.atlan.api.AtlasEndpoint
com.atlan.api.TypeDefsEndpoint
public class TypeDefsEndpoint extends AtlasEndpoint
API endpoints for operating on Atlan's type definitions (in simple terms the underlying metadata model).

  • Field Details

    • RESERVED_SERVICE_TYPES

      public static final Set<String> RESERVED_SERVICE_TYPES

  • Constructor Details

    • TypeDefsEndpoint

      public TypeDefsEndpoint(AtlanClient client)

  • Method Details

    • list

      public TypeDefResponse list(AtlanTypeCategory category) throws AtlanException
      Retrieves a list of the type definitions in Atlan.
      Parameters:
      category - of type definitions to retrieve
      Returns:
      the requested list of type definitions
      Throws:
      AtlanException - on any API communication issue

    • list

      public TypeDefResponse list(AtlanTypeCategory category, RequestOptions options) throws AtlanException
      Retrieves a list of the type definitions in Atlan.
      Parameters:
      category - of type definitions to retrieve
      options - to override default client settings
      Returns:
      the requested list of type definitions
      Throws:
      AtlanException - on any API communication issue

    • list

      public TypeDefResponse list(List<AtlanTypeCategory> categories) throws AtlanException
      Retrieves a list of the type definitions in Atlan.
      Parameters:
      categories - of type definitions to retrieve
      Returns:
      the requested list of type definitions
      Throws:
      AtlanException - on any API communication issue

    • list

      public TypeDefResponse list(List<AtlanTypeCategory> categories, RequestOptions options) throws AtlanException
      Retrieves a list of the type definitions in Atlan.
      Parameters:
      categories - of type definitions to retrieve
      options - to override default client settings
      Returns:
      the requested list of type definitions
      Throws:
      AtlanException - on any API communication issue

    • get

      public TypeDef get(String internalName) throws AtlanException
      Retrieves a specific type definition from Atlan.
      Parameters:
      internalName - the internal (hashed-string, if used) name of the type definition
      Returns:
      details of that specific type definition
      Throws:
      AtlanException - on any API communication issue

    • get

      public TypeDef get(String internalName, RequestOptions options) throws AtlanException
      Retrieves a specific type definition from Atlan.
      Parameters:
      internalName - the internal (hashed-string, if used) name of the type definition
      options - to override default client settings
      Returns:
      details of that specific type definition
      Throws:
      AtlanException - on any API communication issue

    • create

      public TypeDefResponse create(TypeDef typeDef) throws AtlanException
      Create a new type definition in Atlan. Note: only custom metadata, enumerations, and Atlan tag type definitions are currently supported. Furthermore, if any of these are created their respective cache will be force-refreshed.
      Parameters:
      typeDef - to create
      Returns:
      the resulting type definition that was created
      Throws:
      AtlanException - on any API communication issue

    • create

      public TypeDefResponse create(TypeDef typeDef, RequestOptions options) throws AtlanException
      Create a new type definition in Atlan. Note: only custom metadata, enumerations, and Atlan tag type definitions are currently supported. Furthermore, if any of these are created their respective cache will be force-refreshed.
      Parameters:
      typeDef - to create
      options - to override default client settings
      Returns:
      the resulting type definition that was created
      Throws:
      AtlanException - on any API communication issue

    • create

      public TypeDefResponse create(List<TypeDef> typeDefs) throws AtlanException
      Create new type definitions in Atlan. Note: only custom metadata, enumerations, and Atlan tag type definitions are currently supported. Furthermore, if any of these are created their respective cache will be force-refreshed.
      Parameters:
      typeDefs - to create
      Returns:
      the resulting type definition that was created
      Throws:
      AtlanException - on any API communication issue

    • create

      public TypeDefResponse create(List<TypeDef> typeDefs, RequestOptions options) throws AtlanException
      Create new type definitions in Atlan. Note: only custom metadata, enumerations, and Atlan tag type definitions are currently supported. Furthermore, if any of these are created their respective cache will be force-refreshed.
      Parameters:
      typeDefs - to create
      options - to override default client settings
      Returns:
      the resulting type definition that was created
      Throws:
      AtlanException - on any API communication issue

    • _create

      public TypeDefResponse _create(TypeDef typeDef) throws AtlanException
      Create a new type definition in Atlan. NOTE: INTERNAL USE ONLY. This will NOT work without specially-configured policies - use createTypeDef instead. Furthermore, if any of Atlan tag, enum or custom metadata is created their respective cache will be force-refreshed.
      Parameters:
      typeDef - to create
      Returns:
      the resulting type definition that was created
      Throws:
      AtlanException - on any API communication issue
      See Also:

    • _create

      public TypeDefResponse _create(TypeDef typeDef, RequestOptions options) throws AtlanException
      Create a new type definition in Atlan. NOTE: INTERNAL USE ONLY. This will NOT work without specially-configured policies - use createTypeDef instead. Furthermore, if any of Atlan tag, enum or custom metadata is created their respective cache will be force-refreshed.
      Parameters:
      typeDef - to create
      options - to override default client settings
      Returns:
      the resulting type definition that was created
      Throws:
      AtlanException - on any API communication issue
      See Also:

    • _create

      public TypeDefResponse _create(List<TypeDef> typeDefs) throws AtlanException
      Create new type definitions in Atlan. NOTE: INTERNAL USE ONLY. This will NOT work without specially-configured policies - use createTypeDef instead. Furthermore, if any of Atlan tag, enum or custom metadata is created their respective cache will be force-refreshed.
      Parameters:
      typeDefs - to create
      Returns:
      the resulting type definition that was created
      Throws:
      AtlanException - on any API communication issue
      See Also:

    • _create

      public TypeDefResponse _create(List<TypeDef> typeDefs, RequestOptions options) throws AtlanException
      Create new type definitions in Atlan. NOTE: INTERNAL USE ONLY. This will NOT work without specially-configured policies - use createTypeDef instead. Furthermore, if any of Atlan tag, enum or custom metadata is created their respective cache will be force-refreshed.
      Parameters:
      typeDefs - to create
      options - to override default client settings
      Returns:
      the resulting type definition that was created
      Throws:
      AtlanException - on any API communication issue
      See Also:

    • update

      public TypeDefResponse update(TypeDef typeDef) throws AtlanException
      Update an existing type definition in Atlan. Note: only custom metadata and Atlan tag type definitions are currently supported. Furthermore, if any of these are updated their respective cache will be force-refreshed.
      Parameters:
      typeDef - to update
      Returns:
      the resulting type definition that was updated
      Throws:
      AtlanException - on any API communication issue

    • update

      public TypeDefResponse update(TypeDef typeDef, RequestOptions options) throws AtlanException
      Update an existing type definition in Atlan. Note: only custom metadata and Atlan tag type definitions are currently supported. Furthermore, if any of these are updated their respective cache will be force-refreshed.
      Parameters:
      typeDef - to update
      options - to override default client settings
      Returns:
      the resulting type definition that was updated
      Throws:
      AtlanException - on any API communication issue

    • _update

      public TypeDefResponse _update(TypeDef typeDef) throws AtlanException
      Update an existing type definition in Atlan. Note: only custom metadata and Atlan tag type definitions are currently supported. Furthermore, if any Atlan tag, enum or custom metadata is updated their respective cache will be force-refreshed.
      Parameters:
      typeDef - to update
      Returns:
      the resulting type definition that was updated
      Throws:
      AtlanException - on any API communication issue

    • _update

      public TypeDefResponse _update(TypeDef typeDef, RequestOptions options) throws AtlanException
      Update an existing type definition in Atlan. Note: only custom metadata and Atlan tag type definitions are currently supported. Furthermore, if any Atlan tag, enum or custom metadata is updated their respective cache will be force-refreshed.
      Parameters:
      typeDef - to update
      options - to override default client settings
      Returns:
      the resulting type definition that was updated
      Throws:
      AtlanException - on any API communication issue

    • purge

      public void purge(String internalName) throws AtlanException
      Delete the type definition. Furthermore, if an Atlan tag, enum or custom metadata is deleted their respective cache will be force-refreshed
      Parameters:
      internalName - the internal hashed-string name of the type definition
      Throws:
      AtlanException - on any API communication issue

    • purge

      public void purge(String internalName, RequestOptions options) throws AtlanException
      Delete the type definition. Furthermore, if an Atlan tag, enum or custom metadata is deleted their respective cache will be force-refreshed
      Parameters:
      internalName - the internal hashed-string name of the type definition
      options - to override default client settings
      Throws:
      AtlanException - on any API communication issue