Rule (AWS Java SDK :: Services :: Connect 2.20.56 API)

java.lang.Object
- software.amazon.awssdk.services.connect.model.Rule

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Rule.Builder,Rule>

@Generated(value="software.amazon.awssdk:codegen")
public final class Rule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Rule.Builder,Rule>

Information about a rule.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Rule.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Rule.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<RuleAction>`	`actions()` A list of actions to be run when the rule is triggered.
`static Rule.Builder`	`builder()`
`Instant`	`createdTime()` The timestamp for when the rule was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`function()` The conditions of the rule.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasActions()` For responses, this returns true if the service returned a value for the Actions property.
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`lastUpdatedBy()` The Amazon Resource Name (ARN) of the user who last updated the rule.
`Instant`	`lastUpdatedTime()` The timestamp for the when the rule was last updated.
`String`	`name()` The name of the rule.
`RulePublishStatus`	`publishStatus()` The publish status of the rule.
`String`	`publishStatusAsString()` The publish status of the rule.
`String`	`ruleArn()` The Amazon Resource Name (ARN) of the rule.
`String`	`ruleId()` A unique identifier for the rule.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Rule.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` The tags used to organize, track, or control access for this resource.
`Rule.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`RuleTriggerEventSource`	`triggerEventSource()` The event source to trigger the rule.

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
  - name
```
public final String name()
```
    The name of the rule.
    
    Returns:
    
    The name of the rule.
  - ruleId
```
public final String ruleId()
```
    A unique identifier for the rule.
    
    Returns:
    
    A unique identifier for the rule.
  - ruleArn
```
public final String ruleArn()
```
    The Amazon Resource Name (ARN) of the rule.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the rule.
  - triggerEventSource
```
public final RuleTriggerEventSource triggerEventSource()
```
    The event source to trigger the rule.
    
    Returns:
    
    The event source to trigger the rule.
  - function
```
public final String function()
```
    The conditions of the rule.
    
    Returns:
    
    The conditions of the rule.
  - hasActions
```
public final boolean hasActions()
```
    For responses, this returns true if the service returned a value for the Actions 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.
  - actions
```
public final List<RuleAction> actions()
```
    A list of actions to be run when the rule is triggered.
    
    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 hasActions() method.
    
    Returns:
    
    A list of actions to be run when the rule is triggered.
  - publishStatus
```
public final RulePublishStatus publishStatus()
```
    The publish status of the rule.
    
    If the service returns an enum value that is not available in the current SDK version, publishStatus will return RulePublishStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from publishStatusAsString().
    
    Returns:
    
    The publish status of the rule.
    
    See Also:
    
    RulePublishStatus
  - publishStatusAsString
```
public final String publishStatusAsString()
```
    The publish status of the rule.
    
    If the service returns an enum value that is not available in the current SDK version, publishStatus will return RulePublishStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from publishStatusAsString().
    
    Returns:
    
    The publish status of the rule.
    
    See Also:
    
    RulePublishStatus
  - createdTime
```
public final Instant createdTime()
```
    The timestamp for when the rule was created.
    
    Returns:
    
    The timestamp for when the rule was created.
  - lastUpdatedTime
```
public final Instant lastUpdatedTime()
```
    The timestamp for the when the rule was last updated.
    
    Returns:
    
    The timestamp for the when the rule was last updated.
  - lastUpdatedBy
```
public final String lastUpdatedBy()
```
    The Amazon Resource Name (ARN) of the user who last updated the rule.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the user who last updated the rule.
  - 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()
```
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    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:
    
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
  - toBuilder
```
public Rule.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Rule.Builder,Rule>
  - builder
```
public static Rule.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Rule.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Rule

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

ruleId

ruleArn

triggerEventSource

function

hasActions

actions

publishStatus

publishStatusAsString

createdTime

lastUpdatedTime

lastUpdatedBy

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields