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>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListRulesRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`RuleAction`	`action()`	The action of the rule.
`String`	`actionAsString()`	The action of the rule.
`List<String>`	`assetTypes()`	The asset types of the rule.
`static ListRulesRequest.Builder`	`builder()`
`Boolean`	`dataProduct()`	The data product of the rule.
`String`	`domainIdentifier()`	The ID of the domain in which the rules are to be listed.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAssetTypes()`	For responses, this returns true if the service returned a value for the AssetTypes property.
`int`	`hashCode()`
`boolean`	`hasProjectIds()`	For responses, this returns true if the service returned a value for the ProjectIds property.
`Boolean`	`includeCascaded()`	Specifies whether to include cascading rules in the results.
`Integer`	`maxResults()`	The maximum number of rules to return in a single call to `ListRules`.
`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`.
`List<String>`	`projectIds()`	The IDs of projects in which rules are to be listed.
`RuleType`	`ruleType()`	The type of the rule.
`String`	`ruleTypeAsString()`	The type of the rule.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListRulesRequest.Builder>`	`serializableBuilderClass()`
`String`	`targetIdentifier()`	The target ID of the rule.
`RuleTargetType`	`targetType()`	The target type of the rule.
`String`	`targetTypeAsString()`	The target type of the rule.
`ListRulesRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    RuleAction
  - 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:
    
    RuleAction
  - 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:
    
    RuleType
  - 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:
    
    RuleType
  - 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:
    
    RuleTargetType
  - 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:
    
    RuleTargetType
  - toBuilder
```
public ListRulesRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListRulesRequest.Builder,ListRulesRequest>
    
    Specified by:
    
    toBuilder in class DataZoneRequest
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ListRulesRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

action

actionAsString

hasAssetTypes

assetTypes

dataProduct

domainIdentifier

includeCascaded

maxResults

nextToken

hasProjectIds

projectIds

ruleType

ruleTypeAsString

targetIdentifier

targetType

targetTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField