software.amazon.awssdk.services.cleanrooms.model.DifferentialPrivacyTemplateParametersInput Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cleanrooms Show documentation
Show all versions of cleanrooms Show documentation
The AWS Java SDK for Clean Rooms module holds the client classes that are used for
communicating with Clean Rooms.
/*
* 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.cleanrooms.model;
import java.io.Serializable;
import java.util.Arrays;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The epsilon and noise parameter values that you want to use for the differential privacy template.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DifferentialPrivacyTemplateParametersInput implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField EPSILON_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("epsilon").getter(getter(DifferentialPrivacyTemplateParametersInput::epsilon))
.setter(setter(Builder::epsilon))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("epsilon").build()).build();
private static final SdkField USERS_NOISE_PER_QUERY_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("usersNoisePerQuery").getter(getter(DifferentialPrivacyTemplateParametersInput::usersNoisePerQuery))
.setter(setter(Builder::usersNoisePerQuery))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("usersNoisePerQuery").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(EPSILON_FIELD,
USERS_NOISE_PER_QUERY_FIELD));
private static final long serialVersionUID = 1L;
private final Integer epsilon;
private final Integer usersNoisePerQuery;
private DifferentialPrivacyTemplateParametersInput(BuilderImpl builder) {
this.epsilon = builder.epsilon;
this.usersNoisePerQuery = builder.usersNoisePerQuery;
}
/**
*
* The epsilon value that you want to use.
*
*
* @return The epsilon value that you want to use.
*/
public final Integer epsilon() {
return epsilon;
}
/**
*
* Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This
* value governs the rate at which the privacy budget is depleted.
*
*
* @return Noise added per query is measured in terms of the number of users whose contributions you want to
* obscure. This value governs the rate at which the privacy budget is depleted.
*/
public final Integer usersNoisePerQuery() {
return usersNoisePerQuery;
}
@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(epsilon());
hashCode = 31 * hashCode + Objects.hashCode(usersNoisePerQuery());
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 DifferentialPrivacyTemplateParametersInput)) {
return false;
}
DifferentialPrivacyTemplateParametersInput other = (DifferentialPrivacyTemplateParametersInput) obj;
return Objects.equals(epsilon(), other.epsilon()) && Objects.equals(usersNoisePerQuery(), other.usersNoisePerQuery());
}
/**
* 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("DifferentialPrivacyTemplateParametersInput").add("Epsilon", epsilon())
.add("UsersNoisePerQuery", usersNoisePerQuery()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "epsilon":
return Optional.ofNullable(clazz.cast(epsilon()));
case "usersNoisePerQuery":
return Optional.ofNullable(clazz.cast(usersNoisePerQuery()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DifferentialPrivacyTemplateParametersInput) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The epsilon value that you want to use.
*
*
* @param epsilon
* The epsilon value that you want to use.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder epsilon(Integer epsilon);
/**
*
* Noise added per query is measured in terms of the number of users whose contributions you want to obscure.
* This value governs the rate at which the privacy budget is depleted.
*
*
* @param usersNoisePerQuery
* Noise added per query is measured in terms of the number of users whose contributions you want to
* obscure. This value governs the rate at which the privacy budget is depleted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder usersNoisePerQuery(Integer usersNoisePerQuery);
}
static final class BuilderImpl implements Builder {
private Integer epsilon;
private Integer usersNoisePerQuery;
private BuilderImpl() {
}
private BuilderImpl(DifferentialPrivacyTemplateParametersInput model) {
epsilon(model.epsilon);
usersNoisePerQuery(model.usersNoisePerQuery);
}
public final Integer getEpsilon() {
return epsilon;
}
public final void setEpsilon(Integer epsilon) {
this.epsilon = epsilon;
}
@Override
public final Builder epsilon(Integer epsilon) {
this.epsilon = epsilon;
return this;
}
public final Integer getUsersNoisePerQuery() {
return usersNoisePerQuery;
}
public final void setUsersNoisePerQuery(Integer usersNoisePerQuery) {
this.usersNoisePerQuery = usersNoisePerQuery;
}
@Override
public final Builder usersNoisePerQuery(Integer usersNoisePerQuery) {
this.usersNoisePerQuery = usersNoisePerQuery;
return this;
}
@Override
public DifferentialPrivacyTemplateParametersInput build() {
return new DifferentialPrivacyTemplateParametersInput(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}