software.amazon.awssdk.services.cloudwatch.model.ManagedRule 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.io.Serializable;
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.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;
/**
*
* Contains the information that's required to enable a managed Contributor Insights rule for an Amazon Web Services
* resource.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ManagedRule implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField TEMPLATE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TemplateName").getter(getter(ManagedRule::templateName)).setter(setter(Builder::templateName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TemplateName").build()).build();
private static final SdkField RESOURCE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ResourceARN").getter(getter(ManagedRule::resourceARN)).setter(setter(Builder::resourceARN))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ResourceARN").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(ManagedRule::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(TEMPLATE_NAME_FIELD,
RESOURCE_ARN_FIELD, TAGS_FIELD));
private static final long serialVersionUID = 1L;
private final String templateName;
private final String resourceARN;
private final List tags;
private ManagedRule(BuilderImpl builder) {
this.templateName = builder.templateName;
this.resourceARN = builder.resourceARN;
this.tags = builder.tags;
}
/**
*
* The template name for the managed Contributor Insights rule, as returned by ListManagedInsightRules.
*
*
* @return The template name for the managed Contributor Insights rule, as returned by
* ListManagedInsightRules.
*/
public final String templateName() {
return templateName;
}
/**
*
* The ARN of an Amazon Web Services resource that has managed Contributor Insights rules.
*
*
* @return The ARN of an Amazon Web Services resource that has managed Contributor Insights rules.
*/
public final String resourceARN() {
return resourceARN;
}
/**
* 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 that you can associate with a managed Contributor Insights rule. You can associate as
* many as 50 tags with a rule. Tags can help you organize and categorize your resources. You also can use them to
* scope user permissions by granting a user permission to access or change only the resources that have certain tag
* values. 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 that 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 that you can associate with a managed Contributor Insights rule. You can
* associate as many as 50 tags with a rule. Tags can help you organize and categorize your resources. You
* also can use them to scope user permissions by granting a user permission to access or change only the
* resources that have certain tag values. 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
* that 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 + Objects.hashCode(templateName());
hashCode = 31 * hashCode + Objects.hashCode(resourceARN());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ManagedRule)) {
return false;
}
ManagedRule other = (ManagedRule) obj;
return Objects.equals(templateName(), other.templateName()) && Objects.equals(resourceARN(), other.resourceARN())
&& 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("ManagedRule").add("TemplateName", templateName()).add("ResourceARN", resourceARN())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "TemplateName":
return Optional.ofNullable(clazz.cast(templateName()));
case "ResourceARN":
return Optional.ofNullable(clazz.cast(resourceARN()));
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((ManagedRule) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The template name for the managed Contributor Insights rule, as returned by
* ListManagedInsightRules.
*
*
* @param templateName
* The template name for the managed Contributor Insights rule, as returned by
* ListManagedInsightRules.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder templateName(String templateName);
/**
*
* The ARN of an Amazon Web Services resource that has managed Contributor Insights rules.
*
*
* @param resourceARN
* The ARN of an Amazon Web Services resource that has managed Contributor Insights rules.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceARN(String resourceARN);
/**
*
* A list of key-value pairs that you can associate with a managed Contributor Insights rule. You can associate
* as many as 50 tags with a rule. Tags can help you organize and categorize your resources. You also can use
* them to scope user permissions by granting a user permission to access or change only the resources that have
* certain tag values. 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 that 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 that you can associate with a managed Contributor Insights rule. You can
* associate as many as 50 tags with a rule. Tags can help you organize and categorize your resources.
* You also can use them to scope user permissions by granting a user permission to access or change only
* the resources that have certain tag values. 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 that 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 that you can associate with a managed Contributor Insights rule. You can associate
* as many as 50 tags with a rule. Tags can help you organize and categorize your resources. You also can use
* them to scope user permissions by granting a user permission to access or change only the resources that have
* certain tag values. 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 that 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 that you can associate with a managed Contributor Insights rule. You can
* associate as many as 50 tags with a rule. Tags can help you organize and categorize your resources.
* You also can use them to scope user permissions by granting a user permission to access or change only
* the resources that have certain tag values. 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 that 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 that you can associate with a managed Contributor Insights rule. You can associate
* as many as 50 tags with a rule. Tags can help you organize and categorize your resources. You also can use
* them to scope user permissions by granting a user permission to access or change only the resources that have
* certain tag values. 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 that 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);
}
static final class BuilderImpl implements Builder {
private String templateName;
private String resourceARN;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ManagedRule model) {
templateName(model.templateName);
resourceARN(model.resourceARN);
tags(model.tags);
}
public final String getTemplateName() {
return templateName;
}
public final void setTemplateName(String templateName) {
this.templateName = templateName;
}
@Override
public final Builder templateName(String templateName) {
this.templateName = templateName;
return this;
}
public final String getResourceARN() {
return resourceARN;
}
public final void setResourceARN(String resourceARN) {
this.resourceARN = resourceARN;
}
@Override
public final Builder resourceARN(String resourceARN) {
this.resourceARN = resourceARN;
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 ManagedRule build() {
return new ManagedRule(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}