Package software.amazon.awssdk.services.databrew.model

Class DescribeJobRunResponse

    • Method Detail

      • attempt

        public final Integer attempt()

        The number of times that DataBrew has attempted to run the job.

        Returns:
        The number of times that DataBrew has attempted to run the job.

      • completedOn

        public final Instant completedOn()

        The date and time when the job completed processing.

        Returns:
        The date and time when the job completed processing.

      • datasetName

        public final String datasetName()

        The name of the dataset for the job to process.

        Returns:
        The name of the dataset for the job to process.

      • errorMessage

        public final String errorMessage()

        A message indicating an error (if any) that was encountered when the job ran.

        Returns:
        A message indicating an error (if any) that was encountered when the job ran.

      • executionTime

        public final Integer executionTime()

        The amount of time, in seconds, during which the job run consumed resources.

        Returns:
        The amount of time, in seconds, during which the job run consumed resources.

      • jobName

        public final String jobName()

        The name of the job being processed during this run.

        Returns:
        The name of the job being processed during this run.

      • profileConfiguration

        public final ProfileConfiguration profileConfiguration()

        Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

        Returns:
        Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

      • hasValidationConfigurations

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

      • validationConfigurations

        public final List<ValidationConfiguration> validationConfigurations()

        List of validation configurations that are applied to the profile 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 hasValidationConfigurations() method.

        Returns:
        List of validation configurations that are applied to the profile job.

      • runId

        public final String runId()

        The unique identifier of the job run.

        Returns:
        The unique identifier of the job run.

      • state

        public final JobRunState state()

        The current state of the job run entity itself.

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

        Returns:
        The current state of the job run entity itself.
        See Also:
        JobRunState

      • stateAsString

        public final String stateAsString()

        The current state of the job run entity itself.

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

        Returns:
        The current state of the job run entity itself.
        See Also:
        JobRunState

      • logGroupName

        public final String logGroupName()

        The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.

        Returns:
        The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.

      • hasOutputs

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

      • outputs

        public final List<Output> outputs()

        One or more output artifacts from a job run.

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

        Returns:
        One or more output artifacts from a job run.

      • hasDataCatalogOutputs

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

      • dataCatalogOutputs

        public final List<DataCatalogOutput> dataCatalogOutputs()

        One or more artifacts that represent the Glue Data Catalog output from running the 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 hasDataCatalogOutputs() method.

        Returns:
        One or more artifacts that represent the Glue Data Catalog output from running the job.

      • hasDatabaseOutputs

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

      • databaseOutputs

        public final List<DatabaseOutput> databaseOutputs()

        Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

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

        Returns:
        Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

      • recipeReference

        public final RecipeReference recipeReference()
        Returns the value of the RecipeReference property for this object.
        Returns:
        The value of the RecipeReference property for this object.

      • startedBy

        public final String startedBy()

        The Amazon Resource Name (ARN) of the user who started the job run.

        Returns:
        The Amazon Resource Name (ARN) of the user who started the job run.

      • startedOn

        public final Instant startedOn()

        The date and time when the job run began.

        Returns:
        The date and time when the job run began.

      • jobSample

        public final JobSample jobSample()

        Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

        Returns:
        Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

      • 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