Package com.atlan.model.assets

Class S3Bucket

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.S3Bucket
All Implemented Interfaces:
IAsset, IAWS, ICatalog, ICloud, IObjectStore, IReferenceable, IS3, IS3Bucket, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class S3Bucket extends Asset implements IS3Bucket, IS3, IObjectStore, IAWS, ICatalog, IAsset, IReferenceable, ICloud
Instance of an S3 bucket in Atlan.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select()
      Start a fluent search that will return all S3Bucket 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) S3Bucket assets will be included.
      Returns:
      a fluent search that includes all S3Bucket assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
      Start a fluent search that will return all S3Bucket 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) S3Bucket assets will be included.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      Returns:
      a fluent search that includes all S3Bucket assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(boolean includeArchived)
      Start a fluent search that will return all S3Bucket 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) S3Buckets will be included
      Returns:
      a fluent search that includes all S3Bucket assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived)
      Start a fluent search that will return all S3Bucket 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) S3Buckets will be included
      Returns:
      a fluent search that includes all S3Bucket assets

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

      public static S3Bucket get(AtlanClient client, String id) throws AtlanException
      Retrieves a S3Bucket 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 S3Bucket to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full S3Bucket, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the S3Bucket does not exist or the provided GUID is not a S3Bucket

    • get

      public static S3Bucket get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException
      Retrieves a S3Bucket 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 S3Bucket 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 S3Bucket, optionally complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the S3Bucket does not exist or the provided GUID is not a S3Bucket

    • restore

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

    • creator

      public static S3Bucket.S3BucketBuilder<?,?> creator(String name, String connectionQualifiedName)
      Builds the minimal object necessary to create an S3 bucket. Note: this will use the name of the bucket to construct the qualifiedName for the bucket.
      Parameters:
      name - of the S3 bucket
      connectionQualifiedName - unique name of the connection through which the bucket is accessible
      Returns:
      the minimal object necessary to create the S3 bucket, as a builder

    • creator

      public static S3Bucket.S3BucketBuilder<?,?> creator(String name, String connectionQualifiedName, String awsArn)
      Builds the minimal object necessary to create an S3 bucket. Note: this will use the provided ARN to construct the qualifiedName for the bucket.
      Parameters:
      name - of the S3 bucket
      connectionQualifiedName - unique name of the connection through which the bucket is accessible
      awsArn - unique ARN of the bucket
      Returns:
      the minimal object necessary to create the S3 bucket, as a builder

    • updater

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

    • trimToRequired

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

    • removeDescription

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

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

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

    • removeCertificate

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

    • updateAnnouncement

      public static S3Bucket updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a S3Bucket.
      Parameters:
      qualifiedName - of the S3Bucket
      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 S3Bucket updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a S3Bucket.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the S3Bucket's announcement
      qualifiedName - of the S3Bucket
      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 S3Bucket removeAnnouncement(String qualifiedName, String name) throws AtlanException
      Remove the announcement from a S3Bucket.
      Parameters:
      qualifiedName - of the S3Bucket
      name - of the S3Bucket
      Returns:
      the updated S3Bucket, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeAnnouncement

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

    • replaceTerms

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

    • replaceTerms

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

    • appendTerms

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

    • appendTerms

      public static S3Bucket appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Link additional terms to the S3Bucket, without replacing existing terms linked to the S3Bucket. Note: this operation must make two API calls — one to retrieve the S3Bucket'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 S3Bucket
      qualifiedName - for the S3Bucket
      terms - the list of terms to append to the S3Bucket
      Returns:
      the S3Bucket that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems

    • removeTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

      public static S3Bucket appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a S3Bucket, without replacing existing Atlan tags linked to the S3Bucket. Note: this operation must make two API calls — one to retrieve the S3Bucket'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 S3Bucket
      qualifiedName - of the S3Bucket
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated S3Bucket
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static S3Bucket appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a S3Bucket, without replacing existing Atlan tags linked to the S3Bucket. Note: this operation must make two API calls — one to retrieve the S3Bucket's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the S3Bucket
      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 S3Bucket
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static S3Bucket appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a S3Bucket, without replacing existing Atlan tags linked to the S3Bucket. Note: this operation must make two API calls — one to retrieve the S3Bucket'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 S3Bucket
      qualifiedName - of the S3Bucket
      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 S3Bucket
      Throws:
      AtlanException - on any API problems

    • removeAtlanTag

      public static void removeAtlanTag(String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a S3Bucket.
      Parameters:
      qualifiedName - of the S3Bucket
      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 S3Bucket

    • removeAtlanTag

      public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a S3Bucket.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a S3Bucket
      qualifiedName - of the S3Bucket
      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 S3Bucket

    • _internal

      public static S3Bucket.S3BucketBuilder<?,?> _internal()

    • toBuilder

      public S3Bucket.S3BucketBuilder<?,?> 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 IObjectStore
      Specified by:
      getApplicationContainer in interface IS3
      Specified by:
      getApplicationContainer in interface IS3Bucket

    • 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 IObjectStore
      Specified by:
      getAssetApplicationQualifiedName in interface IS3
      Specified by:
      getAssetApplicationQualifiedName in interface IS3Bucket

    • getAwsAccountId

      public String getAwsAccountId()
      12-digit number that uniquely identifies an AWS account.
      Specified by:
      getAwsAccountId in interface IAWS
      Specified by:
      getAwsAccountId in interface IS3
      Specified by:
      getAwsAccountId in interface IS3Bucket

    • getAwsArn

      public String getAwsArn()
      Amazon Resource Name (ARN) for this asset. This uniquely identifies the asset in AWS, and thus must be unique across all AWS asset instances.
      Specified by:
      getAwsArn in interface IAWS
      Specified by:
      getAwsArn in interface IS3
      Specified by:
      getAwsArn in interface IS3Bucket

    • getAwsOwnerId

      public String getAwsOwnerId()
      Root user's ID.
      Specified by:
      getAwsOwnerId in interface IAWS
      Specified by:
      getAwsOwnerId in interface IS3
      Specified by:
      getAwsOwnerId in interface IS3Bucket

    • getAwsOwnerName

      public String getAwsOwnerName()
      Root user's name.
      Specified by:
      getAwsOwnerName in interface IAWS
      Specified by:
      getAwsOwnerName in interface IS3
      Specified by:
      getAwsOwnerName in interface IS3Bucket

    • getAwsPartition

      public String getAwsPartition()
      Group of AWS region and service objects.
      Specified by:
      getAwsPartition in interface IAWS
      Specified by:
      getAwsPartition in interface IS3
      Specified by:
      getAwsPartition in interface IS3Bucket

    • getAwsRegion

      public String getAwsRegion()
      Physical region where the data center in which the asset exists is clustered.
      Specified by:
      getAwsRegion in interface IAWS
      Specified by:
      getAwsRegion in interface IS3
      Specified by:
      getAwsRegion in interface IS3Bucket

    • getAwsResourceId

      public String getAwsResourceId()
      Unique resource ID assigned when a new resource is created.
      Specified by:
      getAwsResourceId in interface IAWS
      Specified by:
      getAwsResourceId in interface IS3
      Specified by:
      getAwsResourceId in interface IS3Bucket

    • getAwsService

      public String getAwsService()
      Type of service in which the asset exists.
      Specified by:
      getAwsService in interface IAWS
      Specified by:
      getAwsService in interface IS3
      Specified by:
      getAwsService in interface IS3Bucket

    • getAwsTags

      public List<AwsTag> getAwsTags()
      List of tags that have been applied to the asset in AWS.
      Specified by:
      getAwsTags in interface IAWS
      Specified by:
      getAwsTags in interface IS3
      Specified by:
      getAwsTags in interface IS3Bucket

    • getInputToAirflowTasks

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
      Specified by:
      getInputToAirflowTasks in interface ICatalog
      Specified by:
      getInputToAirflowTasks in interface IObjectStore
      Specified by:
      getInputToAirflowTasks in interface IS3
      Specified by:
      getInputToAirflowTasks in interface IS3Bucket

    • getInputToProcesses

      public SortedSet<ILineageProcess> getInputToProcesses()
      Processes to which this asset provides input.
      Specified by:
      getInputToProcesses in interface ICatalog
      Specified by:
      getInputToProcesses in interface IObjectStore
      Specified by:
      getInputToProcesses in interface IS3
      Specified by:
      getInputToProcesses in interface IS3Bucket

    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface IObjectStore
      Specified by:
      getInputToSparkJobs in interface IS3
      Specified by:
      getInputToSparkJobs in interface IS3Bucket

    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface ICatalog
      Specified by:
      getModelImplementedEntities in interface IObjectStore
      Specified by:
      getModelImplementedEntities in interface IS3
      Specified by:
      getModelImplementedEntities in interface IS3Bucket

    • getObjects

      public SortedSet<IS3Object> getObjects()
      S3 objects within this bucket.
      Specified by:
      getObjects in interface IS3Bucket

    • getOutputFromAirflowTasks

      public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      Tasks from which this asset is output.
      Specified by:
      getOutputFromAirflowTasks in interface ICatalog
      Specified by:
      getOutputFromAirflowTasks in interface IObjectStore
      Specified by:
      getOutputFromAirflowTasks in interface IS3
      Specified by:
      getOutputFromAirflowTasks in interface IS3Bucket

    • 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 IObjectStore
      Specified by:
      getOutputFromProcesses in interface IS3
      Specified by:
      getOutputFromProcesses in interface IS3Bucket

    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface IObjectStore
      Specified by:
      getOutputFromSparkJobs in interface IS3
      Specified by:
      getOutputFromSparkJobs in interface IS3Bucket

    • getS3BucketVersioningEnabled

      public Boolean getS3BucketVersioningEnabled()
      Whether versioning is enabled for the bucket (true) or not (false).
      Specified by:
      getS3BucketVersioningEnabled in interface IS3Bucket

    • getS3ETag

      public String getS3ETag()
      Entity tag for the asset. An entity tag is a hash of the object and represents changes to the contents of an object only, not its metadata.
      Specified by:
      getS3ETag in interface IS3
      Specified by:
      getS3ETag in interface IS3Bucket

    • getS3Encryption

      public String getS3Encryption()
      TBC
      Specified by:
      getS3Encryption in interface IS3
      Specified by:
      getS3Encryption in interface IS3Bucket

    • getS3ObjectCount

      public Long getS3ObjectCount()
      Number of objects within the bucket.
      Specified by:
      getS3ObjectCount in interface IS3Bucket

    • 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 S3Buckets.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface IAWS
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface ICloud
      Specified by:
      getTypeName in interface IObjectStore
      Specified by:
      getTypeName in interface IReferenceable
      Specified by:
      getTypeName in interface IS3
      Specified by:
      getTypeName in interface IS3Bucket
      Overrides:
      getTypeName in class Reference