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

Class CreateRecipeJobRequest

    • Method Detail

      • datasetName

        public final String datasetName()

        The name of the dataset that this job processes.

        Returns:
        The name of the dataset that this job processes.

      • encryptionKeyArn

        public final String encryptionKeyArn()

        The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

        Returns:
        The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

      • encryptionMode

        public final EncryptionMode encryptionMode()

        The encryption mode for the job, which can be one of the following:

        • SSE-KMS - Server-side encryption with keys managed by KMS.

        • SSE-S3 - Server-side encryption with keys managed by Amazon S3.

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

        Returns:
        The encryption mode for the job, which can be one of the following:

        • SSE-KMS - Server-side encryption with keys managed by KMS.

        • SSE-S3 - Server-side encryption with keys managed by Amazon S3.

        See Also:
        EncryptionMode

      • encryptionModeAsString

        public final String encryptionModeAsString()

        The encryption mode for the job, which can be one of the following:

        • SSE-KMS - Server-side encryption with keys managed by KMS.

        • SSE-S3 - Server-side encryption with keys managed by Amazon S3.

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

        Returns:
        The encryption mode for the job, which can be one of the following:

        • SSE-KMS - Server-side encryption with keys managed by KMS.

        • SSE-S3 - Server-side encryption with keys managed by Amazon S3.

        See Also:
        EncryptionMode

      • name

        public final String name()

        A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

        Returns:
        A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

      • logSubscription

        public final LogSubscription logSubscription()

        Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

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

        Returns:
        Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
        See Also:
        LogSubscription

      • logSubscriptionAsString

        public final String logSubscriptionAsString()

        Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

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

        Returns:
        Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
        See Also:
        LogSubscription

      • maxCapacity

        public final Integer maxCapacity()

        The maximum number of nodes that DataBrew can consume when the job processes data.

        Returns:
        The maximum number of nodes that DataBrew can consume when the job processes data.

      • maxRetries

        public final Integer maxRetries()

        The maximum number of times to retry the job after a job run fails.

        Returns:
        The maximum number of times to retry the job after a job run fails.

      • 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 artifacts that represent the 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 hasOutputs() method.

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

      • 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 to.

        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 to.

      • projectName

        public final String projectName()

        Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.

        Returns:
        Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.

      • 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.

      • roleArn

        public final String roleArn()

        The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

        Returns:
        The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

      • 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 Map<String,​String> tags()

        Metadata tags to apply to this 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:
        Metadata tags to apply to this job.

      • timeout

        public final Integer timeout()

        The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

        Returns:
        The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

      • 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