Package software.amazon.awssdk.services.applicationdiscovery.model

Class ContinuousExportDescription

java.lang.Object
software.amazon.awssdk.services.applicationdiscovery.model.ContinuousExportDescription
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ContinuousExportDescription.Builder,ContinuousExportDescription>
@Generated("software.amazon.awssdk:codegen") public final class ContinuousExportDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ContinuousExportDescription.Builder,ContinuousExportDescription>

A list of continuous export descriptions.

See Also:

  • Method Details

    • exportId

      public final String exportId()

      The unique ID assigned to this export.

      Returns:
      The unique ID assigned to this export.

    • status

      public final ContinuousExportStatus status()

      Describes the status of the export. Can be one of the following values:

      • START_IN_PROGRESS - setting up resources to start continuous export.

      • START_FAILED - an error occurred setting up continuous export. To recover, call start-continuous-export again.

      • ACTIVE - data is being exported to the customer bucket.

      • ERROR - an error occurred during export. To fix the issue, call stop-continuous-export and start-continuous-export.

      • STOP_IN_PROGRESS - stopping the export.

      • STOP_FAILED - an error occurred stopping the export. To recover, call stop-continuous-export again.

      • INACTIVE - the continuous export has been stopped. Data is no longer being exported to the customer bucket.

      If the service returns an enum value that is not available in the current SDK version, status will return ContinuousExportStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      Describes the status of the export. Can be one of the following values:

      • START_IN_PROGRESS - setting up resources to start continuous export.

      • START_FAILED - an error occurred setting up continuous export. To recover, call start-continuous-export again.

      • ACTIVE - data is being exported to the customer bucket.

      • ERROR - an error occurred during export. To fix the issue, call stop-continuous-export and start-continuous-export.

      • STOP_IN_PROGRESS - stopping the export.

      • STOP_FAILED - an error occurred stopping the export. To recover, call stop-continuous-export again.

      • INACTIVE - the continuous export has been stopped. Data is no longer being exported to the customer bucket.

      See Also:

    • statusAsString

      public final String statusAsString()

      Describes the status of the export. Can be one of the following values:

      • START_IN_PROGRESS - setting up resources to start continuous export.

      • START_FAILED - an error occurred setting up continuous export. To recover, call start-continuous-export again.

      • ACTIVE - data is being exported to the customer bucket.

      • ERROR - an error occurred during export. To fix the issue, call stop-continuous-export and start-continuous-export.

      • STOP_IN_PROGRESS - stopping the export.

      • STOP_FAILED - an error occurred stopping the export. To recover, call stop-continuous-export again.

      • INACTIVE - the continuous export has been stopped. Data is no longer being exported to the customer bucket.

      If the service returns an enum value that is not available in the current SDK version, status will return ContinuousExportStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      Describes the status of the export. Can be one of the following values:

      • START_IN_PROGRESS - setting up resources to start continuous export.

      • START_FAILED - an error occurred setting up continuous export. To recover, call start-continuous-export again.

      • ACTIVE - data is being exported to the customer bucket.

      • ERROR - an error occurred during export. To fix the issue, call stop-continuous-export and start-continuous-export.

      • STOP_IN_PROGRESS - stopping the export.

      • STOP_FAILED - an error occurred stopping the export. To recover, call stop-continuous-export again.

      • INACTIVE - the continuous export has been stopped. Data is no longer being exported to the customer bucket.

      See Also:

    • statusDetail

      public final String statusDetail()

      Contains information about any errors that have occurred. This data type can have the following values:

      • ACCESS_DENIED - You don’t have permission to start Data Exploration in Amazon Athena. Contact your Amazon Web Services administrator for help. For more information, see Setting Up Amazon Web Services Application Discovery Service in the Application Discovery Service User Guide.

      • DELIVERY_STREAM_LIMIT_FAILURE - You reached the limit for Amazon Kinesis Data Firehose delivery streams. Reduce the number of streams or request a limit increase and try again. For more information, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide.

      • FIREHOSE_ROLE_MISSING - The Data Exploration feature is in an error state because your user is missing the Amazon Web ServicesApplicationDiscoveryServiceFirehose role. Turn on Data Exploration in Amazon Athena and try again. For more information, see Creating the Amazon Web ServicesApplicationDiscoveryServiceFirehose Role in the Application Discovery Service User Guide.

      • FIREHOSE_STREAM_DOES_NOT_EXIST - The Data Exploration feature is in an error state because your user is missing one or more of the Kinesis data delivery streams.

      • INTERNAL_FAILURE - The Data Exploration feature is in an error state because of an internal failure. Try again later. If this problem persists, contact Amazon Web Services Support.

      • LAKE_FORMATION_ACCESS_DENIED - You don't have sufficient lake formation permissions to start continuous export. For more information, see Upgrading Amazon Web Services Glue Data Permissions to the Amazon Web Services Lake Formation Model in the Amazon Web Services Lake Formation Developer Guide.

        You can use one of the following two ways to resolve this issue.

        1. If you don’t want to use the Lake Formation permission model, you can change the default Data Catalog settings to use only Amazon Web Services Identity and Access Management (IAM) access control for new databases. For more information, see Change Data Catalog Settings in the Lake Formation Developer Guide.

        2. You can give the service-linked IAM roles AWSServiceRoleForApplicationDiscoveryServiceContinuousExport and AWSApplicationDiscoveryServiceFirehose the required Lake Formation permissions. For more information, see Granting Database Permissions in the Lake Formation Developer Guide.

          1. AWSServiceRoleForApplicationDiscoveryServiceContinuousExport - Grant database creator permissions, which gives the role database creation ability and implicit permissions for any created tables. For more information, see Implicit Lake Formation Permissions in the Lake Formation Developer Guide.

          2. AWSApplicationDiscoveryServiceFirehose - Grant describe permissions for all tables in the database.

      • S3_BUCKET_LIMIT_FAILURE - You reached the limit for Amazon S3 buckets. Reduce the number of S3 buckets or request a limit increase and try again. For more information, see Bucket Restrictions and Limitations in the Amazon Simple Storage Service Developer Guide.

      • S3_NOT_SIGNED_UP - Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: https://aws.amazon.com/s3.

      Returns:
      Contains information about any errors that have occurred. This data type can have the following values:

      • ACCESS_DENIED - You don’t have permission to start Data Exploration in Amazon Athena. Contact your Amazon Web Services administrator for help. For more information, see Setting Up Amazon Web Services Application Discovery Service in the Application Discovery Service User Guide.

      • DELIVERY_STREAM_LIMIT_FAILURE - You reached the limit for Amazon Kinesis Data Firehose delivery streams. Reduce the number of streams or request a limit increase and try again. For more information, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide.

      • FIREHOSE_ROLE_MISSING - The Data Exploration feature is in an error state because your user is missing the Amazon Web ServicesApplicationDiscoveryServiceFirehose role. Turn on Data Exploration in Amazon Athena and try again. For more information, see Creating the Amazon Web ServicesApplicationDiscoveryServiceFirehose Role in the Application Discovery Service User Guide.

      • FIREHOSE_STREAM_DOES_NOT_EXIST - The Data Exploration feature is in an error state because your user is missing one or more of the Kinesis data delivery streams.

      • INTERNAL_FAILURE - The Data Exploration feature is in an error state because of an internal failure. Try again later. If this problem persists, contact Amazon Web Services Support.

      • LAKE_FORMATION_ACCESS_DENIED - You don't have sufficient lake formation permissions to start continuous export. For more information, see Upgrading Amazon Web Services Glue Data Permissions to the Amazon Web Services Lake Formation Model in the Amazon Web Services Lake Formation Developer Guide.

        You can use one of the following two ways to resolve this issue.

        1. If you don’t want to use the Lake Formation permission model, you can change the default Data Catalog settings to use only Amazon Web Services Identity and Access Management (IAM) access control for new databases. For more information, see Change Data Catalog Settings in the Lake Formation Developer Guide.

        2. You can give the service-linked IAM roles AWSServiceRoleForApplicationDiscoveryServiceContinuousExport and AWSApplicationDiscoveryServiceFirehose the required Lake Formation permissions. For more information, see Granting Database Permissions in the Lake Formation Developer Guide.

          1. AWSServiceRoleForApplicationDiscoveryServiceContinuousExport - Grant database creator permissions, which gives the role database creation ability and implicit permissions for any created tables. For more information, see Implicit Lake Formation Permissions in the Lake Formation Developer Guide.

          2. AWSApplicationDiscoveryServiceFirehose - Grant describe permissions for all tables in the database.

      • S3_BUCKET_LIMIT_FAILURE - You reached the limit for Amazon S3 buckets. Reduce the number of S3 buckets or request a limit increase and try again. For more information, see Bucket Restrictions and Limitations in the Amazon Simple Storage Service Developer Guide.

      • S3_NOT_SIGNED_UP - Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: https://aws.amazon.com/s3.

    • s3Bucket

      public final String s3Bucket()

      The name of the s3 bucket where the export data parquet files are stored.

      Returns:
      The name of the s3 bucket where the export data parquet files are stored.

    • startTime

      public final Instant startTime()

      The timestamp representing when the continuous export was started.

      Returns:
      The timestamp representing when the continuous export was started.

    • stopTime

      public final Instant stopTime()

      The timestamp that represents when this continuous export was stopped.

      Returns:
      The timestamp that represents when this continuous export was stopped.

    • dataSource

      public final DataSource dataSource()

      The type of data collector used to gather this data (currently only offered for AGENT).

      If the service returns an enum value that is not available in the current SDK version, dataSource will return DataSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataSourceAsString().

      Returns:
      The type of data collector used to gather this data (currently only offered for AGENT).
      See Also:

    • dataSourceAsString

      public final String dataSourceAsString()

      The type of data collector used to gather this data (currently only offered for AGENT).

      If the service returns an enum value that is not available in the current SDK version, dataSource will return DataSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataSourceAsString().

      Returns:
      The type of data collector used to gather this data (currently only offered for AGENT).
      See Also:

    • hasSchemaStorageConfig

      public final boolean hasSchemaStorageConfig()
      For responses, this returns true if the service returned a value for the SchemaStorageConfig property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • schemaStorageConfig

      public final Map<String,String> schemaStorageConfig()

      An object which describes how the data is stored.

      • databaseName - the name of the Glue database used to store the schema.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSchemaStorageConfig() method.

      Returns:
      An object which describes how the data is stored.

      • databaseName - the name of the Glue database used to store the schema.

    • toBuilder

      public ContinuousExportDescription.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ContinuousExportDescription.Builder,ContinuousExportDescription>
      Returns:
      a builder for type T

    • builder

      public static ContinuousExportDescription.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ContinuousExportDescription.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.