software.amazon.awssdk.services.eventbridge.model.RemoveTargetsRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of eventbridge Show documentation
Show all versions of eventbridge Show documentation
The AWS Java SDK for EventBridge module holds the client classes that are used for
communicating with EventBridge.
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.eventbridge.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class RemoveTargetsRequest extends EventBridgeRequest implements
ToCopyableBuilder {
private static final SdkField RULE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Rule")
.getter(getter(RemoveTargetsRequest::rule)).setter(setter(Builder::rule))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Rule").build()).build();
private static final SdkField EVENT_BUS_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EventBusName").getter(getter(RemoveTargetsRequest::eventBusName)).setter(setter(Builder::eventBusName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EventBusName").build()).build();
private static final SdkField> IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Ids")
.getter(getter(RemoveTargetsRequest::ids))
.setter(setter(Builder::ids))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Ids").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField FORCE_FIELD = SdkField. builder(MarshallingType.BOOLEAN).memberName("Force")
.getter(getter(RemoveTargetsRequest::force)).setter(setter(Builder::force))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Force").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RULE_FIELD,
EVENT_BUS_NAME_FIELD, IDS_FIELD, FORCE_FIELD));
private final String rule;
private final String eventBusName;
private final List ids;
private final Boolean force;
private RemoveTargetsRequest(BuilderImpl builder) {
super(builder);
this.rule = builder.rule;
this.eventBusName = builder.eventBusName;
this.ids = builder.ids;
this.force = builder.force;
}
/**
*
* The name of the rule.
*
*
* @return The name of the rule.
*/
public final String rule() {
return rule;
}
/**
*
* The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
*
*
* @return The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is
* used.
*/
public final String eventBusName() {
return eventBusName;
}
/**
* 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.
*/
public final boolean hasIds() {
return ids != null && !(ids instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasIds()} to see if a value was sent in this field.
*
*
* @return The IDs of the targets to remove from the rule.
*/
public final List ids() {
return ids;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final Boolean force() {
return force;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(rule());
hashCode = 31 * hashCode + Objects.hashCode(eventBusName());
hashCode = 31 * hashCode + Objects.hashCode(hasIds() ? ids() : null);
hashCode = 31 * hashCode + Objects.hashCode(force());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof RemoveTargetsRequest)) {
return false;
}
RemoveTargetsRequest other = (RemoveTargetsRequest) obj;
return Objects.equals(rule(), other.rule()) && Objects.equals(eventBusName(), other.eventBusName())
&& hasIds() == other.hasIds() && Objects.equals(ids(), other.ids()) && Objects.equals(force(), other.force());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("RemoveTargetsRequest").add("Rule", rule()).add("EventBusName", eventBusName())
.add("Ids", hasIds() ? ids() : null).add("Force", force()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Rule":
return Optional.ofNullable(clazz.cast(rule()));
case "EventBusName":
return Optional.ofNullable(clazz.cast(eventBusName()));
case "Ids":
return Optional.ofNullable(clazz.cast(ids()));
case "Force":
return Optional.ofNullable(clazz.cast(force()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((RemoveTargetsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends EventBridgeRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the rule.
*
*
* @param rule
* The name of the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rule(String rule);
/**
*
* The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
*
*
* @param eventBusName
* The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is
* used.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder eventBusName(String eventBusName);
/**
*
* The IDs of the targets to remove from the rule.
*
*
* @param ids
* The IDs of the targets to remove from the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ids(Collection ids);
/**
*
* The IDs of the targets to remove from the rule.
*
*
* @param ids
* The IDs of the targets to remove from the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ids(String... ids);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder force(Boolean force);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends EventBridgeRequest.BuilderImpl implements Builder {
private String rule;
private String eventBusName;
private List ids = DefaultSdkAutoConstructList.getInstance();
private Boolean force;
private BuilderImpl() {
}
private BuilderImpl(RemoveTargetsRequest model) {
super(model);
rule(model.rule);
eventBusName(model.eventBusName);
ids(model.ids);
force(model.force);
}
public final String getRule() {
return rule;
}
@Override
public final Builder rule(String rule) {
this.rule = rule;
return this;
}
public final void setRule(String rule) {
this.rule = rule;
}
public final String getEventBusName() {
return eventBusName;
}
@Override
public final Builder eventBusName(String eventBusName) {
this.eventBusName = eventBusName;
return this;
}
public final void setEventBusName(String eventBusName) {
this.eventBusName = eventBusName;
}
public final Collection getIds() {
if (ids instanceof SdkAutoConstructList) {
return null;
}
return ids;
}
@Override
public final Builder ids(Collection ids) {
this.ids = TargetIdListCopier.copy(ids);
return this;
}
@Override
@SafeVarargs
public final Builder ids(String... ids) {
ids(Arrays.asList(ids));
return this;
}
public final void setIds(Collection ids) {
this.ids = TargetIdListCopier.copy(ids);
}
public final Boolean getForce() {
return force;
}
@Override
public final Builder force(Boolean force) {
this.force = force;
return this;
}
public final void setForce(Boolean force) {
this.force = force;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public RemoveTargetsRequest build() {
return new RemoveTargetsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy