Class UpdateRuleRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateRuleRequest.Builder,
UpdateRuleRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<RuleAction> actions()
A list of actions to be run when the rule is triggered.static UpdateRuleRequest.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
function()
The conditions of the rule.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Actions property.final int
hashCode()
final String
The identifier of the Amazon Connect instance.final String
name()
The name of the rule.final RulePublishStatus
The publish status of the rule.final String
The publish status of the rule.final String
ruleId()
A unique identifier for the rule.static Class
<? extends UpdateRuleRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
ruleId
A unique identifier for the rule.
- Returns:
- A unique identifier for the rule.
-
instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Returns:
- The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
-
name
The name of the rule. You can change the name only if
TriggerEventSource
is one of the following values:OnZendeskTicketCreate
|OnZendeskTicketStatusUpdate
|OnSalesforceCaseCreate
- Returns:
- The name of the rule. You can change the name only if
TriggerEventSource
is one of the following values:OnZendeskTicketCreate
|OnZendeskTicketStatusUpdate
|OnSalesforceCaseCreate
-
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 theisEmpty()
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
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
The publish status of the rule.
If the service returns an enum value that is not available in the current SDK version,
publishStatus
will returnRulePublishStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompublishStatusAsString()
.- Returns:
- The publish status of the rule.
- See Also:
-
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 returnRulePublishStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompublishStatusAsString()
.- Returns:
- The publish status of the rule.
- See Also:
-
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 interfaceToCopyableBuilder<UpdateRuleRequest.Builder,
UpdateRuleRequest> - Specified by:
toBuilder
in classConnectRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-