Class ListRulesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.datazone.model.DataZoneRequest
software.amazon.awssdk.services.datazone.model.ListRulesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListRulesRequest.Builder,ListRulesRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListRulesRequest extends DataZoneRequest implements ToCopyableBuilder<ListRulesRequest.Builder,ListRulesRequest>

  • Method Details

    • action

      public final RuleAction action()

      The action of the rule.

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

      Returns:
      The action of the rule.
      See Also:

    • actionAsString

      public final String actionAsString()

      The action of the rule.

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

      Returns:
      The action of the rule.
      See Also:

    • hasAssetTypes

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

    • assetTypes

      public final List<String> assetTypes()

      The asset types of the rule.

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

      Returns:
      The asset types of the rule.

    • dataProduct

      public final Boolean dataProduct()

      The data product of the rule.

      Returns:
      The data product of the rule.

    • domainIdentifier

      public final String domainIdentifier()

      The ID of the domain in which the rules are to be listed.

      Returns:
      The ID of the domain in which the rules are to be listed.

    • includeCascaded

      public final Boolean includeCascaded()

      Specifies whether to include cascading rules in the results.

      Returns:
      Specifies whether to include cascading rules in the results.

    • maxResults

      public final Integer maxResults()

      The maximum number of rules to return in a single call to ListRules. When the number of rules to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListRules to list the next set of rules.

      Returns:
      The maximum number of rules to return in a single call to ListRules. When the number of rules to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListRules to list the next set of rules.

    • nextToken

      public final String nextToken()

      When the number of rules is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of rules, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListRules to list the next set of rules.

      Returns:
      When the number of rules is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of rules, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListRules to list the next set of rules.

    • hasProjectIds

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

    • projectIds

      public final List<String> projectIds()

      The IDs of projects in which rules are to be listed.

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

      Returns:
      The IDs of projects in which rules are to be listed.

    • ruleType

      public final RuleType ruleType()

      The type of the rule.

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

      Returns:
      The type of the rule.
      See Also:

    • ruleTypeAsString

      public final String ruleTypeAsString()

      The type of the rule.

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

      Returns:
      The type of the rule.
      See Also:

    • targetIdentifier

      public final String targetIdentifier()

      The target ID of the rule.

      Returns:
      The target ID of the rule.

    • targetType

      public final RuleTargetType targetType()

      The target type of the rule.

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

      Returns:
      The target type of the rule.
      See Also:

    • targetTypeAsString

      public final String targetTypeAsString()

      The target type of the rule.

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

      Returns:
      The target type of the rule.
      See Also:

    • toBuilder

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

    • builder

      public static ListRulesRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.