Package com.atlan.model.assets

Class CosmosMongoDBAccount

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.CosmosMongoDBAccount
All Implemented Interfaces:
IAsset, ICatalog, ICosmosMongoDB, ICosmosMongoDBAccount, INoSQL, IReferenceable, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class CosmosMongoDBAccount extends Asset implements ICosmosMongoDBAccount, ICosmosMongoDB, INoSQL, ICatalog, IAsset, IReferenceable
Instance of a Cosmos MongoDB account in Atlan.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

      public CosmosMongoDBAccount trimToReference() throws InvalidRequestException
      Builds the minimal object necessary to create a relationship to a CosmosMongoDBAccount, from a potentially more-complete CosmosMongoDBAccount object.
      Overrides:
      trimToReference in class Asset
      Returns:
      the minimal object necessary to relate to the CosmosMongoDBAccount
      Throws:
      InvalidRequestException - if any of the minimal set of required properties for a CosmosMongoDBAccount relationship are not found in the initial object

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select()
      Start a fluent search that will return all CosmosMongoDBAccount assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) CosmosMongoDBAccount assets will be included.
      Returns:
      a fluent search that includes all CosmosMongoDBAccount assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
      Start a fluent search that will return all CosmosMongoDBAccount assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) CosmosMongoDBAccount assets will be included.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      Returns:
      a fluent search that includes all CosmosMongoDBAccount assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(boolean includeArchived)
      Start a fluent search that will return all CosmosMongoDBAccount assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.
      Parameters:
      includeArchived - when true, archived (soft-deleted) CosmosMongoDBAccounts will be included
      Returns:
      a fluent search that includes all CosmosMongoDBAccount assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived)
      Start a fluent search that will return all CosmosMongoDBAccount assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      includeArchived - when true, archived (soft-deleted) CosmosMongoDBAccounts will be included
      Returns:
      a fluent search that includes all CosmosMongoDBAccount assets

    • refByGuid

      public static CosmosMongoDBAccount refByGuid(String guid)
      Reference to a CosmosMongoDBAccount by GUID. Use this to create a relationship to this CosmosMongoDBAccount, where the relationship should be replaced.
      Parameters:
      guid - the GUID of the CosmosMongoDBAccount to reference
      Returns:
      reference to a CosmosMongoDBAccount that can be used for defining a relationship to a CosmosMongoDBAccount

    • refByGuid

      public static CosmosMongoDBAccount refByGuid(String guid, Reference.SaveSemantic semantic)
      Reference to a CosmosMongoDBAccount by GUID. Use this to create a relationship to this CosmosMongoDBAccount, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
      Parameters:
      guid - the GUID of the CosmosMongoDBAccount to reference
      semantic - how to save this relationship (replace all with this, append it, or remove it)
      Returns:
      reference to a CosmosMongoDBAccount that can be used for defining a relationship to a CosmosMongoDBAccount

    • refByQualifiedName

      public static CosmosMongoDBAccount refByQualifiedName(String qualifiedName)
      Reference to a CosmosMongoDBAccount by qualifiedName. Use this to create a relationship to this CosmosMongoDBAccount, where the relationship should be replaced.
      Parameters:
      qualifiedName - the qualifiedName of the CosmosMongoDBAccount to reference
      Returns:
      reference to a CosmosMongoDBAccount that can be used for defining a relationship to a CosmosMongoDBAccount

    • refByQualifiedName

      public static CosmosMongoDBAccount refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)
      Reference to a CosmosMongoDBAccount by qualifiedName. Use this to create a relationship to this CosmosMongoDBAccount, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
      Parameters:
      qualifiedName - the qualifiedName of the CosmosMongoDBAccount to reference
      semantic - how to save this relationship (replace all with this, append it, or remove it)
      Returns:
      reference to a CosmosMongoDBAccount that can be used for defining a relationship to a CosmosMongoDBAccount

    • get

      public static CosmosMongoDBAccount get(String id) throws AtlanException
      Retrieves a CosmosMongoDBAccount by one of its identifiers, complete with all of its relationships.
      Parameters:
      id - of the CosmosMongoDBAccount to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full CosmosMongoDBAccount, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the CosmosMongoDBAccount does not exist or the provided GUID is not a CosmosMongoDBAccount

    • get

      public static CosmosMongoDBAccount get(AtlanClient client, String id) throws AtlanException
      Retrieves a CosmosMongoDBAccount by one of its identifiers, complete with all of its relationships.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the CosmosMongoDBAccount to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full CosmosMongoDBAccount, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the CosmosMongoDBAccount does not exist or the provided GUID is not a CosmosMongoDBAccount

    • get

      public static CosmosMongoDBAccount get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException
      Retrieves a CosmosMongoDBAccount by one of its identifiers, optionally complete with all of its relationships.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the CosmosMongoDBAccount to retrieve, either its GUID or its full qualifiedName
      includeRelationships - if true, all of the asset's relationships will also be retrieved; if false, no relationships will be retrieved
      Returns:
      the requested full CosmosMongoDBAccount, optionally complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the CosmosMongoDBAccount does not exist or the provided GUID is not a CosmosMongoDBAccount

    • restore

      public static boolean restore(String qualifiedName) throws AtlanException
      Restore the archived (soft-deleted) CosmosMongoDBAccount to active.
      Parameters:
      qualifiedName - for the CosmosMongoDBAccount
      Returns:
      true if the CosmosMongoDBAccount is now active, and false otherwise
      Throws:
      AtlanException - on any API problems

    • restore

      public static boolean restore(AtlanClient client, String qualifiedName) throws AtlanException
      Restore the archived (soft-deleted) CosmosMongoDBAccount to active.
      Parameters:
      client - connectivity to the Atlan tenant on which to restore the asset
      qualifiedName - for the CosmosMongoDBAccount
      Returns:
      true if the CosmosMongoDBAccount is now active, and false otherwise
      Throws:
      AtlanException - on any API problems

    • updater

      public static CosmosMongoDBAccount.CosmosMongoDBAccountBuilder<?,?> updater(String qualifiedName, String name)
      Builds the minimal object necessary to update a CosmosMongoDBAccount.
      Parameters:
      qualifiedName - of the CosmosMongoDBAccount
      name - of the CosmosMongoDBAccount
      Returns:
      the minimal request necessary to update the CosmosMongoDBAccount, as a builder

    • trimToRequired

      public CosmosMongoDBAccount.CosmosMongoDBAccountBuilder<?,?> trimToRequired() throws InvalidRequestException
      Builds the minimal object necessary to apply an update to a CosmosMongoDBAccount, from a potentially more-complete CosmosMongoDBAccount object.
      Overrides:
      trimToRequired in class Asset
      Returns:
      the minimal object necessary to update the CosmosMongoDBAccount, as a builder
      Throws:
      InvalidRequestException - if any of the minimal set of required properties for CosmosMongoDBAccount are not found in the initial object

    • removeDescription

      public static CosmosMongoDBAccount removeDescription(String qualifiedName, String name) throws AtlanException
      Remove the system description from a CosmosMongoDBAccount.
      Parameters:
      qualifiedName - of the CosmosMongoDBAccount
      name - of the CosmosMongoDBAccount
      Returns:
      the updated CosmosMongoDBAccount, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeDescription

      public static CosmosMongoDBAccount removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the system description from a CosmosMongoDBAccount.
      Parameters:
      client - connectivity to the Atlan tenant on which to remove the asset's description
      qualifiedName - of the CosmosMongoDBAccount
      name - of the CosmosMongoDBAccount
      Returns:
      the updated CosmosMongoDBAccount, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeUserDescription

      public static CosmosMongoDBAccount removeUserDescription(String qualifiedName, String name) throws AtlanException
      Remove the user's description from a CosmosMongoDBAccount.
      Parameters:
      qualifiedName - of the CosmosMongoDBAccount
      name - of the CosmosMongoDBAccount
      Returns:
      the updated CosmosMongoDBAccount, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeUserDescription

      public static CosmosMongoDBAccount removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the user's description from a CosmosMongoDBAccount.
      Parameters:
      client - connectivity to the Atlan tenant on which to remove the asset's description
      qualifiedName - of the CosmosMongoDBAccount
      name - of the CosmosMongoDBAccount
      Returns:
      the updated CosmosMongoDBAccount, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeOwners

      public static CosmosMongoDBAccount removeOwners(String qualifiedName, String name) throws AtlanException
      Remove the owners from a CosmosMongoDBAccount.
      Parameters:
      qualifiedName - of the CosmosMongoDBAccount
      name - of the CosmosMongoDBAccount
      Returns:
      the updated CosmosMongoDBAccount, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeOwners

      public static CosmosMongoDBAccount removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the owners from a CosmosMongoDBAccount.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the CosmosMongoDBAccount's owners
      qualifiedName - of the CosmosMongoDBAccount
      name - of the CosmosMongoDBAccount
      Returns:
      the updated CosmosMongoDBAccount, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • updateCertificate

      public static CosmosMongoDBAccount updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException
      Update the certificate on a CosmosMongoDBAccount.
      Parameters:
      qualifiedName - of the CosmosMongoDBAccount
      certificate - to use
      message - (optional) message, or null if no message
      Returns:
      the updated CosmosMongoDBAccount, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • updateCertificate

      public static CosmosMongoDBAccount updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException
      Update the certificate on a CosmosMongoDBAccount.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the CosmosMongoDBAccount's certificate
      qualifiedName - of the CosmosMongoDBAccount
      certificate - to use
      message - (optional) message, or null if no message
      Returns:
      the updated CosmosMongoDBAccount, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • removeCertificate

      public static CosmosMongoDBAccount removeCertificate(String qualifiedName, String name) throws AtlanException
      Remove the certificate from a CosmosMongoDBAccount.
      Parameters:
      qualifiedName - of the CosmosMongoDBAccount
      name - of the CosmosMongoDBAccount
      Returns:
      the updated CosmosMongoDBAccount, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeCertificate

      public static CosmosMongoDBAccount removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the certificate from a CosmosMongoDBAccount.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the CosmosMongoDBAccount's certificate
      qualifiedName - of the CosmosMongoDBAccount
      name - of the CosmosMongoDBAccount
      Returns:
      the updated CosmosMongoDBAccount, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • updateAnnouncement

      public static CosmosMongoDBAccount updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a CosmosMongoDBAccount.
      Parameters:
      qualifiedName - of the CosmosMongoDBAccount
      type - type of announcement to set
      title - (optional) title of the announcement to set (or null for no title)
      message - (optional) message of the announcement to set (or null for no message)
      Returns:
      the result of the update, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • updateAnnouncement

      public static CosmosMongoDBAccount updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a CosmosMongoDBAccount.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the CosmosMongoDBAccount's announcement
      qualifiedName - of the CosmosMongoDBAccount
      type - type of announcement to set
      title - (optional) title of the announcement to set (or null for no title)
      message - (optional) message of the announcement to set (or null for no message)
      Returns:
      the result of the update, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • removeAnnouncement

      public static CosmosMongoDBAccount removeAnnouncement(String qualifiedName, String name) throws AtlanException
      Remove the announcement from a CosmosMongoDBAccount.
      Parameters:
      qualifiedName - of the CosmosMongoDBAccount
      name - of the CosmosMongoDBAccount
      Returns:
      the updated CosmosMongoDBAccount, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeAnnouncement

      public static CosmosMongoDBAccount removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the announcement from a CosmosMongoDBAccount.
      Parameters:
      client - connectivity to the Atlan client from which to remove the CosmosMongoDBAccount's announcement
      qualifiedName - of the CosmosMongoDBAccount
      name - of the CosmosMongoDBAccount
      Returns:
      the updated CosmosMongoDBAccount, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • replaceTerms

      public static CosmosMongoDBAccount replaceTerms(String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
      Replace the terms linked to the CosmosMongoDBAccount.
      Parameters:
      qualifiedName - for the CosmosMongoDBAccount
      name - human-readable name of the CosmosMongoDBAccount
      terms - the list of terms to replace on the CosmosMongoDBAccount, or null to remove all terms from the CosmosMongoDBAccount
      Returns:
      the CosmosMongoDBAccount that was updated (note that it will NOT contain details of the replaced terms)
      Throws:
      AtlanException - on any API problems

    • replaceTerms

      public static CosmosMongoDBAccount replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
      Replace the terms linked to the CosmosMongoDBAccount.
      Parameters:
      client - connectivity to the Atlan tenant on which to replace the CosmosMongoDBAccount's assigned terms
      qualifiedName - for the CosmosMongoDBAccount
      name - human-readable name of the CosmosMongoDBAccount
      terms - the list of terms to replace on the CosmosMongoDBAccount, or null to remove all terms from the CosmosMongoDBAccount
      Returns:
      the CosmosMongoDBAccount that was updated (note that it will NOT contain details of the replaced terms)
      Throws:
      AtlanException - on any API problems

    • appendTerms

      public static CosmosMongoDBAccount appendTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Link additional terms to the CosmosMongoDBAccount, without replacing existing terms linked to the CosmosMongoDBAccount. Note: this operation must make two API calls — one to retrieve the CosmosMongoDBAccount's existing terms, and a second to append the new terms.
      Parameters:
      qualifiedName - for the CosmosMongoDBAccount
      terms - the list of terms to append to the CosmosMongoDBAccount
      Returns:
      the CosmosMongoDBAccount that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems

    • appendTerms

      public static CosmosMongoDBAccount appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Link additional terms to the CosmosMongoDBAccount, without replacing existing terms linked to the CosmosMongoDBAccount. Note: this operation must make two API calls — one to retrieve the CosmosMongoDBAccount's existing terms, and a second to append the new terms.
      Parameters:
      client - connectivity to the Atlan tenant on which to append terms to the CosmosMongoDBAccount
      qualifiedName - for the CosmosMongoDBAccount
      terms - the list of terms to append to the CosmosMongoDBAccount
      Returns:
      the CosmosMongoDBAccount that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems

    • removeTerms

      public static CosmosMongoDBAccount removeTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Remove terms from a CosmosMongoDBAccount, without replacing all existing terms linked to the CosmosMongoDBAccount. Note: this operation must make two API calls — one to retrieve the CosmosMongoDBAccount's existing terms, and a second to remove the provided terms.
      Parameters:
      qualifiedName - for the CosmosMongoDBAccount
      terms - the list of terms to remove from the CosmosMongoDBAccount, which must be referenced by GUID
      Returns:
      the CosmosMongoDBAccount that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems

    • removeTerms

      public static CosmosMongoDBAccount removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Remove terms from a CosmosMongoDBAccount, without replacing all existing terms linked to the CosmosMongoDBAccount. Note: this operation must make two API calls — one to retrieve the CosmosMongoDBAccount's existing terms, and a second to remove the provided terms.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove terms from the CosmosMongoDBAccount
      qualifiedName - for the CosmosMongoDBAccount
      terms - the list of terms to remove from the CosmosMongoDBAccount, which must be referenced by GUID
      Returns:
      the CosmosMongoDBAccount that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static CosmosMongoDBAccount appendAtlanTags(String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a CosmosMongoDBAccount, without replacing existing Atlan tags linked to the CosmosMongoDBAccount. Note: this operation must make two API calls — one to retrieve the CosmosMongoDBAccount's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the CosmosMongoDBAccount
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated CosmosMongoDBAccount
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static CosmosMongoDBAccount appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a CosmosMongoDBAccount, without replacing existing Atlan tags linked to the CosmosMongoDBAccount. Note: this operation must make two API calls — one to retrieve the CosmosMongoDBAccount's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      client - connectivity to the Atlan tenant on which to append Atlan tags to the CosmosMongoDBAccount
      qualifiedName - of the CosmosMongoDBAccount
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated CosmosMongoDBAccount
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static CosmosMongoDBAccount appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a CosmosMongoDBAccount, without replacing existing Atlan tags linked to the CosmosMongoDBAccount. Note: this operation must make two API calls — one to retrieve the CosmosMongoDBAccount's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the CosmosMongoDBAccount
      atlanTagNames - human-readable names of the Atlan tags to add
      propagate - whether to propagate the Atlan tag (true) or not (false)
      removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
      restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)
      Returns:
      the updated CosmosMongoDBAccount
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static CosmosMongoDBAccount appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a CosmosMongoDBAccount, without replacing existing Atlan tags linked to the CosmosMongoDBAccount. Note: this operation must make two API calls — one to retrieve the CosmosMongoDBAccount's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      client - connectivity to the Atlan tenant on which to append Atlan tags to the CosmosMongoDBAccount
      qualifiedName - of the CosmosMongoDBAccount
      atlanTagNames - human-readable names of the Atlan tags to add
      propagate - whether to propagate the Atlan tag (true) or not (false)
      removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
      restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)
      Returns:
      the updated CosmosMongoDBAccount
      Throws:
      AtlanException - on any API problems

    • removeAtlanTag

      public static void removeAtlanTag(String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a CosmosMongoDBAccount.
      Parameters:
      qualifiedName - of the CosmosMongoDBAccount
      atlanTagName - human-readable name of the Atlan tag to remove
      Throws:
      AtlanException - on any API problems, or if the Atlan tag does not exist on the CosmosMongoDBAccount

    • removeAtlanTag

      public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a CosmosMongoDBAccount.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a CosmosMongoDBAccount
      qualifiedName - of the CosmosMongoDBAccount
      atlanTagName - human-readable name of the Atlan tag to remove
      Throws:
      AtlanException - on any API problems, or if the Atlan tag does not exist on the CosmosMongoDBAccount

    • _internal

      public static CosmosMongoDBAccount.CosmosMongoDBAccountBuilder<?,?> _internal()

    • toBuilder

      public CosmosMongoDBAccount.CosmosMongoDBAccountBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getApplicationContainer

      public IApplicationContainer getApplicationContainer()
      ApplicationContainer asset containing this Catalog asset.
      Specified by:
      getApplicationContainer in interface ICatalog
      Specified by:
      getApplicationContainer in interface ICosmosMongoDB
      Specified by:
      getApplicationContainer in interface ICosmosMongoDBAccount
      Specified by:
      getApplicationContainer in interface INoSQL

    • getAssetApplicationQualifiedName

      public String getAssetApplicationQualifiedName()
      Qualified name of the Application Container that contains this asset.
      Specified by:
      getAssetApplicationQualifiedName in interface ICatalog
      Specified by:
      getAssetApplicationQualifiedName in interface ICosmosMongoDB
      Specified by:
      getAssetApplicationQualifiedName in interface ICosmosMongoDBAccount
      Specified by:
      getAssetApplicationQualifiedName in interface INoSQL

    • getCosmosMongoDBAccountConsistencyPolicy

      public String getCosmosMongoDBAccountConsistencyPolicy()
      The consistency policy configured for the Cosmos MongoDB account.
      Specified by:
      getCosmosMongoDBAccountConsistencyPolicy in interface ICosmosMongoDBAccount

    • getCosmosMongoDBAccountDocumentEndpoint

      public String getCosmosMongoDBAccountDocumentEndpoint()
      The Document Endpoint URL for the Cosmos MongoDB account.
      Specified by:
      getCosmosMongoDBAccountDocumentEndpoint in interface ICosmosMongoDBAccount

    • getCosmosMongoDBAccountEnableAutomaticFailover

      public Boolean getCosmosMongoDBAccountEnableAutomaticFailover()
      Indicates whether automatic failover is enabled for the Cosmos MongoDB account.
      Specified by:
      getCosmosMongoDBAccountEnableAutomaticFailover in interface ICosmosMongoDBAccount

    • getCosmosMongoDBAccountEnableMultipleWriteLocations

      public Boolean getCosmosMongoDBAccountEnableMultipleWriteLocations()
      Indicates whether multiple write locations are enabled for the Cosmos MongoDB account.
      Specified by:
      getCosmosMongoDBAccountEnableMultipleWriteLocations in interface ICosmosMongoDBAccount

    • getCosmosMongoDBAccountEnablePartitionKeyMonitor

      public Boolean getCosmosMongoDBAccountEnablePartitionKeyMonitor()
      Indicates whether partition key monitoring is enabled for the Cosmos MongoDB account.
      Specified by:
      getCosmosMongoDBAccountEnablePartitionKeyMonitor in interface ICosmosMongoDBAccount

    • getCosmosMongoDBAccountInstanceId

      public String getCosmosMongoDBAccountInstanceId()
      The unique identifier for the Cosmos MongoDB account.
      Specified by:
      getCosmosMongoDBAccountInstanceId in interface ICosmosMongoDBAccount

    • getCosmosMongoDBAccountIsVirtualNetworkFilterEnabled

      public Boolean getCosmosMongoDBAccountIsVirtualNetworkFilterEnabled()
      Indicates whether the virtual network filter is enabled for the Cosmos MongoDB account.
      Specified by:
      getCosmosMongoDBAccountIsVirtualNetworkFilterEnabled in interface ICosmosMongoDBAccount

    • getCosmosMongoDBAccountLocations

      public SortedSet<String> getCosmosMongoDBAccountLocations()
      The locations where the Cosmos MongoDB account is available.
      Specified by:
      getCosmosMongoDBAccountLocations in interface ICosmosMongoDBAccount

    • getCosmosMongoDBAccountMongoEndpoint

      public String getCosmosMongoDBAccountMongoEndpoint()
      The MongoDB connection endpoint for the Cosmos MongoDB account.
      Specified by:
      getCosmosMongoDBAccountMongoEndpoint in interface ICosmosMongoDBAccount

    • getCosmosMongoDBAccountPublicNetworkAccess

      public String getCosmosMongoDBAccountPublicNetworkAccess()
      The status of public network access for the Cosmos MongoDB account.
      Specified by:
      getCosmosMongoDBAccountPublicNetworkAccess in interface ICosmosMongoDBAccount

    • getCosmosMongoDBAccountReadLocations

      public SortedSet<String> getCosmosMongoDBAccountReadLocations()
      The read locations configured for the Cosmos MongoDB account.
      Specified by:
      getCosmosMongoDBAccountReadLocations in interface ICosmosMongoDBAccount

    • getCosmosMongoDBAccountResourceGroup

      public String getCosmosMongoDBAccountResourceGroup()
      The resource group that contains the Cosmos MongoDB account.
      Specified by:
      getCosmosMongoDBAccountResourceGroup in interface ICosmosMongoDBAccount

    • getCosmosMongoDBAccountSubscriptionId

      public String getCosmosMongoDBAccountSubscriptionId()
      The ID of the subscription to which the Cosmos MongoDB account belongs.
      Specified by:
      getCosmosMongoDBAccountSubscriptionId in interface ICosmosMongoDBAccount

    • getCosmosMongoDBAccountType

      public String getCosmosMongoDBAccountType()
      The type of the Cosmos MongoDB account, such as RU or VCORE.
      Specified by:
      getCosmosMongoDBAccountType in interface ICosmosMongoDBAccount

    • getCosmosMongoDBAccountWriteLocations

      public SortedSet<String> getCosmosMongoDBAccountWriteLocations()
      The write locations configured for the Cosmos MongoDB account.
      Specified by:
      getCosmosMongoDBAccountWriteLocations in interface ICosmosMongoDBAccount

    • getCosmosMongoDBDatabaseCount

      public Long getCosmosMongoDBDatabaseCount()
      Number of databases in this Cosmos MongoDB account.
      Specified by:
      getCosmosMongoDBDatabaseCount in interface ICosmosMongoDBAccount

    • getCosmosMongoDBDatabases

      public SortedSet<ICosmosMongoDBDatabase> getCosmosMongoDBDatabases()
      Databases that exist within this account.
      Specified by:
      getCosmosMongoDBDatabases in interface ICosmosMongoDBAccount

    • getInputToAirflowTasks

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
      Specified by:
      getInputToAirflowTasks in interface ICatalog
      Specified by:
      getInputToAirflowTasks in interface ICosmosMongoDB
      Specified by:
      getInputToAirflowTasks in interface ICosmosMongoDBAccount
      Specified by:
      getInputToAirflowTasks in interface INoSQL

    • getInputToProcesses

      public SortedSet<ILineageProcess> getInputToProcesses()
      Processes to which this asset provides input.
      Specified by:
      getInputToProcesses in interface ICatalog
      Specified by:
      getInputToProcesses in interface ICosmosMongoDB
      Specified by:
      getInputToProcesses in interface ICosmosMongoDBAccount
      Specified by:
      getInputToProcesses in interface INoSQL

    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface ICosmosMongoDB
      Specified by:
      getInputToSparkJobs in interface ICosmosMongoDBAccount
      Specified by:
      getInputToSparkJobs in interface INoSQL

    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface ICatalog
      Specified by:
      getModelImplementedEntities in interface ICosmosMongoDB
      Specified by:
      getModelImplementedEntities in interface ICosmosMongoDBAccount
      Specified by:
      getModelImplementedEntities in interface INoSQL

    • getNoSQLSchemaDefinition

      public String getNoSQLSchemaDefinition()
      Represents attributes for describing the key schema for the table and indexes.
      Specified by:
      getNoSQLSchemaDefinition in interface ICosmosMongoDB
      Specified by:
      getNoSQLSchemaDefinition in interface ICosmosMongoDBAccount
      Specified by:
      getNoSQLSchemaDefinition in interface INoSQL

    • getOutputFromAirflowTasks

      public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      Tasks from which this asset is output.
      Specified by:
      getOutputFromAirflowTasks in interface ICatalog
      Specified by:
      getOutputFromAirflowTasks in interface ICosmosMongoDB
      Specified by:
      getOutputFromAirflowTasks in interface ICosmosMongoDBAccount
      Specified by:
      getOutputFromAirflowTasks in interface INoSQL

    • getOutputFromProcesses

      public SortedSet<ILineageProcess> getOutputFromProcesses()
      Processes from which this asset is produced as output.
      Specified by:
      getOutputFromProcesses in interface ICatalog
      Specified by:
      getOutputFromProcesses in interface ICosmosMongoDB
      Specified by:
      getOutputFromProcesses in interface ICosmosMongoDBAccount
      Specified by:
      getOutputFromProcesses in interface INoSQL

    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface ICosmosMongoDB
      Specified by:
      getOutputFromSparkJobs in interface ICosmosMongoDBAccount
      Specified by:
      getOutputFromSparkJobs in interface INoSQL

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Asset

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class Asset

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Asset

    • toString

      public String toString()
      Description copied from class: AtlanObject
      Overrides:
      toString in class Asset

    • getTypeName

      public String getTypeName()
      Fixed typeName for CosmosMongoDBAccounts.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface ICosmosMongoDB
      Specified by:
      getTypeName in interface ICosmosMongoDBAccount
      Specified by:
      getTypeName in interface INoSQL
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference