Package software.amazon.awssdk.services.connect.model

Class CreateRuleRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.connect.model.ConnectRequest

software.amazon.awssdk.services.connect.model.CreateRuleRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateRuleRequest
extends ConnectRequest
implements ToCopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateRuleRequest.Builder

Method Summary

Modifier and Type	Method	Description
List<RuleAction>	actions()	A list of actions to be run when the rule is triggered.
static CreateRuleRequest.Builder	builder()
String	clientToken()	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
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()
String	instanceId()	The identifier of the Amazon Connect instance.
String	name()	A unique name for the rule.
RulePublishStatus	publishStatus()	The publish status of the rule.
String	publishStatusAsString()	The publish status of the rule.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateRuleRequest.Builder>	serializableBuilderClass()
CreateRuleRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
RuleTriggerEventSource	triggerEventSource()	The event source to trigger the rule.

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

instanceId

public final String 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

public final String name()

A unique name for the rule.

Returns:

A unique name for 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

clientToken

public final String clientToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

toBuilder

public CreateRuleRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>

Specified by:

toBuilder in class ConnectRequest

builder

public static CreateRuleRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateRuleRequest.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