software.amazon.awssdk.services.eventbridge.model

Class RemoveTargetsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.eventbridge.model.EventBridgeRequest

software.amazon.awssdk.services.eventbridge.model.RemoveTargetsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RemoveTargetsRequest.Builder,RemoveTargetsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RemoveTargetsRequest
extends EventBridgeRequest
implements ToCopyableBuilder<RemoveTargetsRequest.Builder,RemoveTargetsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RemoveTargetsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static RemoveTargetsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
String	eventBusName() The name or ARN of the event bus associated with the rule.
Boolean	force() If this is a managed rule, created by an AWS service on your behalf, you must specify Force as True to remove targets.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
boolean	hasIds() Returns true if the Ids property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<String>	ids() The IDs of the targets to remove from the rule.
String	rule() The name of the rule.
List<SdkField<?>>	sdkFields()
static Class<? extends RemoveTargetsRequest.Builder>	serializableBuilderClass()
RemoveTargetsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

rule

public final String rule()

The name of the rule.

Returns:

The name of the rule.

eventBusName

public final String eventBusName()

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

Returns:

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

hasIds

public final boolean hasIds()

Returns true if the Ids property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

ids

public final List<String> ids()

The IDs of the targets to remove from the rule.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasIds() to see if a value was sent in this field.

Returns:

The IDs of the targets to remove from the rule.

force

public final Boolean force()

If this is a managed rule, created by an AWS service on your behalf, you must specify Force as True to remove targets. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.

Returns:

If this is a managed rule, created by an AWS service on your behalf, you must specify Force as True to remove targets. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.

toBuilder

public RemoveTargetsRequest.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<RemoveTargetsRequest.Builder,RemoveTargetsRequest>

Specified by:

toBuilder in class EventBridgeRequest

Returns:

a builder for type T

builder

public static RemoveTargetsRequest.Builder builder()

serializableBuilderClass

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