Class DescribeRulesetResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.databrew.model.DataBrewResponse
software.amazon.awssdk.services.databrew.model.DescribeRulesetResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeRulesetResponse.Builder,DescribeRulesetResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeRulesetResponse extends DataBrewResponse implements ToCopyableBuilder<DescribeRulesetResponse.Builder,DescribeRulesetResponse>

  • Method Details

    • name

      public final String name()

      The name of the ruleset.

      Returns:
      The name of the ruleset.

    • description

      public final String description()

      The description of the ruleset.

      Returns:
      The description of the ruleset.

    • targetArn

      public final String targetArn()

      The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.

      Returns:
      The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.

    • hasRules

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

    • rules

      public final List<Rule> rules()

      A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.

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

      Returns:
      A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.

    • createDate

      public final Instant createDate()

      The date and time that the ruleset was created.

      Returns:
      The date and time that the ruleset was created.

    • createdBy

      public final String createdBy()

      The Amazon Resource Name (ARN) of the user who created the ruleset.

      Returns:
      The Amazon Resource Name (ARN) of the user who created the ruleset.

    • lastModifiedBy

      public final String lastModifiedBy()

      The Amazon Resource Name (ARN) of the user who last modified the ruleset.

      Returns:
      The Amazon Resource Name (ARN) of the user who last modified the ruleset.

    • lastModifiedDate

      public final Instant lastModifiedDate()

      The modification date and time of the ruleset.

      Returns:
      The modification date and time of the ruleset.

    • resourceArn

      public final String resourceArn()

      The Amazon Resource Name (ARN) for the ruleset.

      Returns:
      The Amazon Resource Name (ARN) for the ruleset.

    • 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 that have been applied to the ruleset.

      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 that have been applied to the ruleset.

    • toBuilder

      public DescribeRulesetResponse.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<DescribeRulesetResponse.Builder,DescribeRulesetResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeRulesetResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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