software.amazon.awssdk.services.eventbridge.model.PutRuleRequest 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 2014-2019 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 java.util.stream.Collectors;
import java.util.stream.Stream;
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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class PutRuleRequest extends EventBridgeRequest implements ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(PutRuleRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField SCHEDULE_EXPRESSION_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(PutRuleRequest::scheduleExpression)).setter(setter(Builder::scheduleExpression))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ScheduleExpression").build())
.build();
private static final SdkField EVENT_PATTERN_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(PutRuleRequest::eventPattern)).setter(setter(Builder::eventPattern))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EventPattern").build()).build();
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(PutRuleRequest::stateAsString)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("State").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(PutRuleRequest::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField ROLE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(PutRuleRequest::roleArn)).setter(setter(Builder::roleArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RoleArn").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(PutRuleRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField EVENT_BUS_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(PutRuleRequest::eventBusName)).setter(setter(Builder::eventBusName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EventBusName").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD,
SCHEDULE_EXPRESSION_FIELD, EVENT_PATTERN_FIELD, STATE_FIELD, DESCRIPTION_FIELD, ROLE_ARN_FIELD, TAGS_FIELD,
EVENT_BUS_NAME_FIELD));
private final String name;
private final String scheduleExpression;
private final String eventPattern;
private final String state;
private final String description;
private final String roleArn;
private final List tags;
private final String eventBusName;
private PutRuleRequest(BuilderImpl builder) {
super(builder);
this.name = builder.name;
this.scheduleExpression = builder.scheduleExpression;
this.eventPattern = builder.eventPattern;
this.state = builder.state;
this.description = builder.description;
this.roleArn = builder.roleArn;
this.tags = builder.tags;
this.eventBusName = builder.eventBusName;
}
/**
*
* The name of the rule that you're creating or updating.
*
*
* @return The name of the rule that you're creating or updating.
*/
public String name() {
return name;
}
/**
*
* The scheduling expression: for example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
*
*
* @return The scheduling expression: for example, "cron(0 20 * * ? *)" or
* "rate(5 minutes)".
*/
public String scheduleExpression() {
return scheduleExpression;
}
/**
*
* The event pattern. For more information, see Event
* Patterns in the Amazon EventBridge User Guide.
*
*
* @return The event pattern. For more information, see Event
* Patterns in the Amazon EventBridge User Guide.
*/
public String eventPattern() {
return eventPattern;
}
/**
*
* Indicates whether the rule is enabled or disabled.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link RuleState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return Indicates whether the rule is enabled or disabled.
* @see RuleState
*/
public RuleState state() {
return RuleState.fromValue(state);
}
/**
*
* Indicates whether the rule is enabled or disabled.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link RuleState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return Indicates whether the rule is enabled or disabled.
* @see RuleState
*/
public String stateAsString() {
return state;
}
/**
*
* A description of the rule.
*
*
* @return A description of the rule.
*/
public String description() {
return description;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role associated with the rule.
*
*
* @return The Amazon Resource Name (ARN) of the IAM role associated with the rule.
*/
public String roleArn() {
return roleArn;
}
/**
*
* The list of key-value pairs to associate with the rule.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return The list of key-value pairs to associate with the rule.
*/
public List tags() {
return tags;
}
/**
*
* The event bus to associate with this rule. If you omit this, the default event bus is used.
*
*
* @return The event bus to associate with this rule. If you omit this, the default event bus is used.
*/
public String eventBusName() {
return eventBusName;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(scheduleExpression());
hashCode = 31 * hashCode + Objects.hashCode(eventPattern());
hashCode = 31 * hashCode + Objects.hashCode(stateAsString());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(roleArn());
hashCode = 31 * hashCode + Objects.hashCode(tags());
hashCode = 31 * hashCode + Objects.hashCode(eventBusName());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof PutRuleRequest)) {
return false;
}
PutRuleRequest other = (PutRuleRequest) obj;
return Objects.equals(name(), other.name()) && Objects.equals(scheduleExpression(), other.scheduleExpression())
&& Objects.equals(eventPattern(), other.eventPattern()) && Objects.equals(stateAsString(), other.stateAsString())
&& Objects.equals(description(), other.description()) && Objects.equals(roleArn(), other.roleArn())
&& Objects.equals(tags(), other.tags()) && Objects.equals(eventBusName(), other.eventBusName());
}
/**
* 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 String toString() {
return ToString.builder("PutRuleRequest").add("Name", name()).add("ScheduleExpression", scheduleExpression())
.add("EventPattern", eventPattern()).add("State", stateAsString()).add("Description", description())
.add("RoleArn", roleArn()).add("Tags", tags()).add("EventBusName", eventBusName()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "ScheduleExpression":
return Optional.ofNullable(clazz.cast(scheduleExpression()));
case "EventPattern":
return Optional.ofNullable(clazz.cast(eventPattern()));
case "State":
return Optional.ofNullable(clazz.cast(stateAsString()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "RoleArn":
return Optional.ofNullable(clazz.cast(roleArn()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
case "EventBusName":
return Optional.ofNullable(clazz.cast(eventBusName()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PutRuleRequest) 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 that you're creating or updating.
*
*
* @param name
* The name of the rule that you're creating or updating.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The scheduling expression: for example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
*
*
* @param scheduleExpression
* The scheduling expression: for example, "cron(0 20 * * ? *)" or
* "rate(5 minutes)".
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder scheduleExpression(String scheduleExpression);
/**
*
* The event pattern. For more information, see Event
* Patterns in the Amazon EventBridge User Guide.
*
*
* @param eventPattern
* The event pattern. For more information, see Event Patterns in the Amazon EventBridge User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder eventPattern(String eventPattern);
/**
*
* Indicates whether the rule is enabled or disabled.
*
*
* @param state
* Indicates whether the rule is enabled or disabled.
* @see RuleState
* @return Returns a reference to this object so that method calls can be chained together.
* @see RuleState
*/
Builder state(String state);
/**
*
* Indicates whether the rule is enabled or disabled.
*
*
* @param state
* Indicates whether the rule is enabled or disabled.
* @see RuleState
* @return Returns a reference to this object so that method calls can be chained together.
* @see RuleState
*/
Builder state(RuleState state);
/**
*
* A description of the rule.
*
*
* @param description
* A description of the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The Amazon Resource Name (ARN) of the IAM role associated with the rule.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of the IAM role associated with the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder roleArn(String roleArn);
/**
*
* The list of key-value pairs to associate with the rule.
*
*
* @param tags
* The list of key-value pairs to associate with the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* The list of key-value pairs to associate with the rule.
*
*
* @param tags
* The list of key-value pairs to associate with the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* The list of key-value pairs to associate with the rule.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create
* one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result
* is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(List)
*/
Builder tags(Consumer... tags);
/**
*
* The event bus to associate with this rule. If you omit this, the default event bus is used.
*
*
* @param eventBusName
* The event bus to associate with this 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);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends EventBridgeRequest.BuilderImpl implements Builder {
private String name;
private String scheduleExpression;
private String eventPattern;
private String state;
private String description;
private String roleArn;
private List tags = DefaultSdkAutoConstructList.getInstance();
private String eventBusName;
private BuilderImpl() {
}
private BuilderImpl(PutRuleRequest model) {
super(model);
name(model.name);
scheduleExpression(model.scheduleExpression);
eventPattern(model.eventPattern);
state(model.state);
description(model.description);
roleArn(model.roleArn);
tags(model.tags);
eventBusName(model.eventBusName);
}
public final String getName() {
return name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final void setName(String name) {
this.name = name;
}
public final String getScheduleExpression() {
return scheduleExpression;
}
@Override
public final Builder scheduleExpression(String scheduleExpression) {
this.scheduleExpression = scheduleExpression;
return this;
}
public final void setScheduleExpression(String scheduleExpression) {
this.scheduleExpression = scheduleExpression;
}
public final String getEventPattern() {
return eventPattern;
}
@Override
public final Builder eventPattern(String eventPattern) {
this.eventPattern = eventPattern;
return this;
}
public final void setEventPattern(String eventPattern) {
this.eventPattern = eventPattern;
}
public final String getStateAsString() {
return state;
}
@Override
public final Builder state(String state) {
this.state = state;
return this;
}
@Override
public final Builder state(RuleState state) {
this.state(state == null ? null : state.toString());
return this;
}
public final void setState(String state) {
this.state = state;
}
public final String getDescription() {
return description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final void setDescription(String description) {
this.description = description;
}
public final String getRoleArn() {
return roleArn;
}
@Override
public final Builder roleArn(String roleArn) {
this.roleArn = roleArn;
return this;
}
public final void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
public final Collection getTags() {
return tags != null ? tags.stream().map(Tag::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
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;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public PutRuleRequest build() {
return new PutRuleRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy