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)
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 Amazon Web Services service on your behalf, you must specify Force as True to remove targets.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIds() For responses, this returns true if the service returned a value for the Ids property.
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()
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

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()

For responses, this returns true if the service returned a value for the Ids 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.

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.

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 hasIds() method.

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 Amazon Web Services 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 Amazon Web Services 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()

Specified by:

toBuilder in interface ToCopyableBuilder<RemoveTargetsRequest.Builder,RemoveTargetsRequest>

Specified by:

toBuilder in class EventBridgeRequest

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)

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