Class CreateDatasetExportJobRequest

    • Method Detail

      • jobName

        public final String jobName()

        The name for the dataset export job.

        Returns:
        The name for the dataset export job.
      • datasetArn

        public final String datasetArn()

        The Amazon Resource Name (ARN) of the dataset that contains the data to export.

        Returns:
        The Amazon Resource Name (ARN) of the dataset that contains the data to export.
      • ingestionMode

        public final IngestionMode ingestionMode()

        The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

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

        Returns:
        The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.
        See Also:
        IngestionMode
      • ingestionModeAsString

        public final String ingestionModeAsString()

        The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

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

        Returns:
        The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.
        See Also:
        IngestionMode
      • roleArn

        public final String roleArn()

        The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

        Returns:
        The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
      • jobOutput

        public final DatasetExportJobOutput jobOutput()

        The path to the Amazon S3 bucket where the job's output is stored.

        Returns:
        The path to the Amazon S3 bucket where the job's output is stored.
      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags 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.
      • tags

        public final List<Tag> tags()

        A list of tags to apply to the dataset export job.

        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 hasTags() method.

        Returns:
        A list of tags to apply to the dataset export job.
      • 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