software.amazon.awssdk.services.shield.model.Protection Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of shield Show documentation
Show all versions of shield Show documentation
The AWS Java SDK for AWS Shield module holds the client classes that are used for communicating with
AWS Shield.
/*
* 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.shield.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.Function;
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;
/**
*
* An object that represents a resource that is under DDoS protection.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Protection implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(Protection::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Id").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(Protection::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField RESOURCE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(Protection::resourceArn)).setter(setter(Builder::resourceArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ResourceArn").build()).build();
private static final SdkField> HEALTH_CHECK_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(Protection::healthCheckIds))
.setter(setter(Builder::healthCheckIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HealthCheckIds").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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ID_FIELD, NAME_FIELD,
RESOURCE_ARN_FIELD, HEALTH_CHECK_IDS_FIELD));
private static final long serialVersionUID = 1L;
private final String id;
private final String name;
private final String resourceArn;
private final List healthCheckIds;
private Protection(BuilderImpl builder) {
this.id = builder.id;
this.name = builder.name;
this.resourceArn = builder.resourceArn;
this.healthCheckIds = builder.healthCheckIds;
}
/**
*
* The unique identifier (ID) of the protection.
*
*
* @return The unique identifier (ID) of the protection.
*/
public String id() {
return id;
}
/**
*
* The friendly name of the protection. For example, My CloudFront distributions
.
*
*
* @return The friendly name of the protection. For example, My CloudFront distributions
.
*/
public String name() {
return name;
}
/**
*
* The ARN (Amazon Resource Name) of the AWS resource that is protected.
*
*
* @return The ARN (Amazon Resource Name) of the AWS resource that is protected.
*/
public String resourceArn() {
return resourceArn;
}
/**
* Returns true if the HealthCheckIds 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 boolean hasHealthCheckIds() {
return healthCheckIds != null && !(healthCheckIds instanceof SdkAutoConstructList);
}
/**
*
* The unique identifier (ID) for the Route 53 health check that's associated with the protection.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasHealthCheckIds()} to see if a value was sent in this field.
*
*
* @return The unique identifier (ID) for the Route 53 health check that's associated with the protection.
*/
public List healthCheckIds() {
return healthCheckIds;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(id());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(resourceArn());
hashCode = 31 * hashCode + Objects.hashCode(healthCheckIds());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Protection)) {
return false;
}
Protection other = (Protection) obj;
return Objects.equals(id(), other.id()) && Objects.equals(name(), other.name())
&& Objects.equals(resourceArn(), other.resourceArn()) && Objects.equals(healthCheckIds(), other.healthCheckIds());
}
/**
* 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("Protection").add("Id", id()).add("Name", name()).add("ResourceArn", resourceArn())
.add("HealthCheckIds", healthCheckIds()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Id":
return Optional.ofNullable(clazz.cast(id()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "ResourceArn":
return Optional.ofNullable(clazz.cast(resourceArn()));
case "HealthCheckIds":
return Optional.ofNullable(clazz.cast(healthCheckIds()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function
© 2015 - 2025 Weber Informatics LLC | Privacy Policy