software.amazon.awssdk.services.cloudwatch.model.PutInsightRuleRequest Maven / Gradle / Ivy
Show all versions of cloudwatch Show documentation
/*
* 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.cloudwatch.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.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 PutInsightRuleRequest extends CloudWatchRequest implements
ToCopyableBuilder {
private static final SdkField RULE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RuleName").getter(getter(PutInsightRuleRequest::ruleName)).setter(setter(Builder::ruleName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RuleName").build()).build();
private static final SdkField RULE_STATE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RuleState").getter(getter(PutInsightRuleRequest::ruleState)).setter(setter(Builder::ruleState))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RuleState").build()).build();
private static final SdkField RULE_DEFINITION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RuleDefinition").getter(getter(PutInsightRuleRequest::ruleDefinition))
.setter(setter(Builder::ruleDefinition))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RuleDefinition").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(PutInsightRuleRequest::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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RULE_NAME_FIELD,
RULE_STATE_FIELD, RULE_DEFINITION_FIELD, TAGS_FIELD));
private final String ruleName;
private final String ruleState;
private final String ruleDefinition;
private final List tags;
private PutInsightRuleRequest(BuilderImpl builder) {
super(builder);
this.ruleName = builder.ruleName;
this.ruleState = builder.ruleState;
this.ruleDefinition = builder.ruleDefinition;
this.tags = builder.tags;
}
/**
*
* A unique name for the rule.
*
*
* @return A unique name for the rule.
*/
public final String ruleName() {
return ruleName;
}
/**
*
* The state of the rule. Valid values are ENABLED and DISABLED.
*
*
* @return The state of the rule. Valid values are ENABLED and DISABLED.
*/
public final String ruleState() {
return ruleState;
}
/**
*
* The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.
*
*
* @return The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.
*/
public final String ruleDefinition() {
return ruleDefinition;
}
/**
* For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags
* with a rule.
*
*
* Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
* granting a user permission to access or change only the resources that have certain tag values.
*
*
* To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in
* addition to the cloudwatch:PutInsightRule permission.
*
*
* If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this
* parameter are ignored. To change the tags of an existing rule, use TagResource.
*
*
* 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 {@link #hasTags} method.
*
*
* @return A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as
* 50 tags with a rule.
*
* Tags can help you organize and categorize your resources. You can also use them to scope user
* permissions, by granting a user permission to access or change only the resources that have certain tag
* values.
*
*
* To be able to associate tags with a rule, you must have the cloudwatch:TagResource
* permission in addition to the cloudwatch:PutInsightRule permission.
*
*
* If you are using this operation to update an existing Contributor Insights rule, any tags you specify in
* this parameter are ignored. To change the tags of an existing rule, use TagResource.
*/
public final List tags() {
return tags;
}
@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(ruleName());
hashCode = 31 * hashCode + Objects.hashCode(ruleState());
hashCode = 31 * hashCode + Objects.hashCode(ruleDefinition());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
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 PutInsightRuleRequest)) {
return false;
}
PutInsightRuleRequest other = (PutInsightRuleRequest) obj;
return Objects.equals(ruleName(), other.ruleName()) && Objects.equals(ruleState(), other.ruleState())
&& Objects.equals(ruleDefinition(), other.ruleDefinition()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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("PutInsightRuleRequest").add("RuleName", ruleName()).add("RuleState", ruleState())
.add("RuleDefinition", ruleDefinition()).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "RuleName":
return Optional.ofNullable(clazz.cast(ruleName()));
case "RuleState":
return Optional.ofNullable(clazz.cast(ruleState()));
case "RuleDefinition":
return Optional.ofNullable(clazz.cast(ruleDefinition()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PutInsightRuleRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CloudWatchRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* A unique name for the rule.
*
*
* @param ruleName
* A unique name for the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ruleName(String ruleName);
/**
*
* The state of the rule. Valid values are ENABLED and DISABLED.
*
*
* @param ruleState
* The state of the rule. Valid values are ENABLED and DISABLED.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ruleState(String ruleState);
/**
*
* The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.
*
*
* @param ruleDefinition
* The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ruleDefinition(String ruleDefinition);
/**
*
* A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50
* tags with a rule.
*
*
* Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
* granting a user permission to access or change only the resources that have certain tag values.
*
*
* To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in
* addition to the cloudwatch:PutInsightRule permission.
*
*
* If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this
* parameter are ignored. To change the tags of an existing rule, use TagResource.
*
*
* @param tags
* A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many
* as 50 tags with a rule.
*
* Tags can help you organize and categorize your resources. You can also use them to scope user
* permissions, by granting a user permission to access or change only the resources that have certain
* tag values.
*
*
* To be able to associate tags with a rule, you must have the cloudwatch:TagResource
* permission in addition to the cloudwatch:PutInsightRule permission.
*
*
* If you are using this operation to update an existing Contributor Insights rule, any tags you specify
* in this parameter are ignored. To change the tags of an existing rule, use TagResource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50
* tags with a rule.
*
*
* Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
* granting a user permission to access or change only the resources that have certain tag values.
*
*
* To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in
* addition to the cloudwatch:PutInsightRule permission.
*
*
* If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this
* parameter are ignored. To change the tags of an existing rule, use TagResource.
*
*
* @param tags
* A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many
* as 50 tags with a rule.
*
* Tags can help you organize and categorize your resources. You can also use them to scope user
* permissions, by granting a user permission to access or change only the resources that have certain
* tag values.
*
*
* To be able to associate tags with a rule, you must have the cloudwatch:TagResource
* permission in addition to the cloudwatch:PutInsightRule permission.
*
*
* If you are using this operation to update an existing Contributor Insights rule, any tags you specify
* in this parameter are ignored. To change the tags of an existing rule, use TagResource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50
* tags with a rule.
*
*
* Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
* granting a user permission to access or change only the resources that have certain tag values.
*
*
* To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in
* addition to the cloudwatch:PutInsightRule permission.
*
*
* If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this
* parameter are ignored. To change the tags of an existing rule, use TagResource.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.cloudwatch.model.Tag.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.cloudwatch.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.cloudwatch.model.Tag.Builder#build()} is called immediately and its
* result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CloudWatchRequest.BuilderImpl implements Builder {
private String ruleName;
private String ruleState;
private String ruleDefinition;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(PutInsightRuleRequest model) {
super(model);
ruleName(model.ruleName);
ruleState(model.ruleState);
ruleDefinition(model.ruleDefinition);
tags(model.tags);
}
public final String getRuleName() {
return ruleName;
}
public final void setRuleName(String ruleName) {
this.ruleName = ruleName;
}
@Override
public final Builder ruleName(String ruleName) {
this.ruleName = ruleName;
return this;
}
public final String getRuleState() {
return ruleState;
}
public final void setRuleState(String ruleState) {
this.ruleState = ruleState;
}
@Override
public final Builder ruleState(String ruleState) {
this.ruleState = ruleState;
return this;
}
public final String getRuleDefinition() {
return ruleDefinition;
}
public final void setRuleDefinition(String ruleDefinition) {
this.ruleDefinition = ruleDefinition;
}
@Override
public final Builder ruleDefinition(String ruleDefinition) {
this.ruleDefinition = ruleDefinition;
return this;
}
public final List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@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;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public PutInsightRuleRequest build() {
return new PutInsightRuleRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}