software.amazon.awssdk.services.cleanrooms.model.PrivacyBudgetTemplate Maven / Gradle / Ivy
Show all versions of cleanrooms 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.cleanrooms.model;
import java.io.Serializable;
import java.time.Instant;
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.Consumer;
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;
/**
*
* An object that defines the privacy budget template.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PrivacyBudgetTemplate implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("id")
.getter(getter(PrivacyBudgetTemplate::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("id").build()).build();
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("arn")
.getter(getter(PrivacyBudgetTemplate::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("arn").build()).build();
private static final SdkField MEMBERSHIP_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("membershipId").getter(getter(PrivacyBudgetTemplate::membershipId)).setter(setter(Builder::membershipId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("membershipId").build()).build();
private static final SdkField MEMBERSHIP_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("membershipArn").getter(getter(PrivacyBudgetTemplate::membershipArn))
.setter(setter(Builder::membershipArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("membershipArn").build()).build();
private static final SdkField COLLABORATION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("collaborationId").getter(getter(PrivacyBudgetTemplate::collaborationId))
.setter(setter(Builder::collaborationId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("collaborationId").build()).build();
private static final SdkField COLLABORATION_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("collaborationArn").getter(getter(PrivacyBudgetTemplate::collaborationArn))
.setter(setter(Builder::collaborationArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("collaborationArn").build()).build();
private static final SdkField CREATE_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("createTime").getter(getter(PrivacyBudgetTemplate::createTime)).setter(setter(Builder::createTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("createTime").build()).build();
private static final SdkField UPDATE_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("updateTime").getter(getter(PrivacyBudgetTemplate::updateTime)).setter(setter(Builder::updateTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("updateTime").build()).build();
private static final SdkField PRIVACY_BUDGET_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("privacyBudgetType").getter(getter(PrivacyBudgetTemplate::privacyBudgetTypeAsString))
.setter(setter(Builder::privacyBudgetType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("privacyBudgetType").build()).build();
private static final SdkField AUTO_REFRESH_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("autoRefresh").getter(getter(PrivacyBudgetTemplate::autoRefreshAsString))
.setter(setter(Builder::autoRefresh))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("autoRefresh").build()).build();
private static final SdkField PARAMETERS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("parameters")
.getter(getter(PrivacyBudgetTemplate::parameters)).setter(setter(Builder::parameters))
.constructor(PrivacyBudgetTemplateParametersOutput::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("parameters").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ID_FIELD, ARN_FIELD,
MEMBERSHIP_ID_FIELD, MEMBERSHIP_ARN_FIELD, COLLABORATION_ID_FIELD, COLLABORATION_ARN_FIELD, CREATE_TIME_FIELD,
UPDATE_TIME_FIELD, PRIVACY_BUDGET_TYPE_FIELD, AUTO_REFRESH_FIELD, PARAMETERS_FIELD));
private static final long serialVersionUID = 1L;
private final String id;
private final String arn;
private final String membershipId;
private final String membershipArn;
private final String collaborationId;
private final String collaborationArn;
private final Instant createTime;
private final Instant updateTime;
private final String privacyBudgetType;
private final String autoRefresh;
private final PrivacyBudgetTemplateParametersOutput parameters;
private PrivacyBudgetTemplate(BuilderImpl builder) {
this.id = builder.id;
this.arn = builder.arn;
this.membershipId = builder.membershipId;
this.membershipArn = builder.membershipArn;
this.collaborationId = builder.collaborationId;
this.collaborationArn = builder.collaborationArn;
this.createTime = builder.createTime;
this.updateTime = builder.updateTime;
this.privacyBudgetType = builder.privacyBudgetType;
this.autoRefresh = builder.autoRefresh;
this.parameters = builder.parameters;
}
/**
*
* The unique identifier of the privacy budget template.
*
*
* @return The unique identifier of the privacy budget template.
*/
public final String id() {
return id;
}
/**
*
* The ARN of the privacy budget template.
*
*
* @return The ARN of the privacy budget template.
*/
public final String arn() {
return arn;
}
/**
*
* The identifier for a membership resource.
*
*
* @return The identifier for a membership resource.
*/
public final String membershipId() {
return membershipId;
}
/**
*
* The Amazon Resource Name (ARN) of the member who created the privacy budget template.
*
*
* @return The Amazon Resource Name (ARN) of the member who created the privacy budget template.
*/
public final String membershipArn() {
return membershipArn;
}
/**
*
* The unique ID of the collaboration that contains this privacy budget template.
*
*
* @return The unique ID of the collaboration that contains this privacy budget template.
*/
public final String collaborationId() {
return collaborationId;
}
/**
*
* The ARN of the collaboration that contains this privacy budget template.
*
*
* @return The ARN of the collaboration that contains this privacy budget template.
*/
public final String collaborationArn() {
return collaborationArn;
}
/**
*
* The time at which the privacy budget template was created.
*
*
* @return The time at which the privacy budget template was created.
*/
public final Instant createTime() {
return createTime;
}
/**
*
* The most recent time at which the privacy budget template was updated.
*
*
* @return The most recent time at which the privacy budget template was updated.
*/
public final Instant updateTime() {
return updateTime;
}
/**
*
* Specifies the type of the privacy budget template.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #privacyBudgetType}
* will return {@link PrivacyBudgetType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #privacyBudgetTypeAsString}.
*
*
* @return Specifies the type of the privacy budget template.
* @see PrivacyBudgetType
*/
public final PrivacyBudgetType privacyBudgetType() {
return PrivacyBudgetType.fromValue(privacyBudgetType);
}
/**
*
* Specifies the type of the privacy budget template.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #privacyBudgetType}
* will return {@link PrivacyBudgetType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #privacyBudgetTypeAsString}.
*
*
* @return Specifies the type of the privacy budget template.
* @see PrivacyBudgetType
*/
public final String privacyBudgetTypeAsString() {
return privacyBudgetType;
}
/**
*
* How often the privacy budget refreshes.
*
*
*
* If you plan to regularly bring new data into the collaboration, use CALENDAR_MONTH
to automatically
* get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary
* amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid
* choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #autoRefresh} will
* return {@link PrivacyBudgetTemplateAutoRefresh#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #autoRefreshAsString}.
*
*
* @return How often the privacy budget refreshes.
*
* If you plan to regularly bring new data into the collaboration, use CALENDAR_MONTH
to
* automatically get a new privacy budget for the collaboration every calendar month. Choosing this option
* allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried
* across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget
* refreshes.
*
* @see PrivacyBudgetTemplateAutoRefresh
*/
public final PrivacyBudgetTemplateAutoRefresh autoRefresh() {
return PrivacyBudgetTemplateAutoRefresh.fromValue(autoRefresh);
}
/**
*
* How often the privacy budget refreshes.
*
*
*
* If you plan to regularly bring new data into the collaboration, use CALENDAR_MONTH
to automatically
* get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary
* amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid
* choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #autoRefresh} will
* return {@link PrivacyBudgetTemplateAutoRefresh#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #autoRefreshAsString}.
*
*
* @return How often the privacy budget refreshes.
*
* If you plan to regularly bring new data into the collaboration, use CALENDAR_MONTH
to
* automatically get a new privacy budget for the collaboration every calendar month. Choosing this option
* allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried
* across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget
* refreshes.
*
* @see PrivacyBudgetTemplateAutoRefresh
*/
public final String autoRefreshAsString() {
return autoRefresh;
}
/**
*
* Specifies the epsilon and noise parameters for the privacy budget template.
*
*
* @return Specifies the epsilon and noise parameters for the privacy budget template.
*/
public final PrivacyBudgetTemplateParametersOutput parameters() {
return parameters;
}
@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 final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(id());
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(membershipId());
hashCode = 31 * hashCode + Objects.hashCode(membershipArn());
hashCode = 31 * hashCode + Objects.hashCode(collaborationId());
hashCode = 31 * hashCode + Objects.hashCode(collaborationArn());
hashCode = 31 * hashCode + Objects.hashCode(createTime());
hashCode = 31 * hashCode + Objects.hashCode(updateTime());
hashCode = 31 * hashCode + Objects.hashCode(privacyBudgetTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(autoRefreshAsString());
hashCode = 31 * hashCode + Objects.hashCode(parameters());
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 PrivacyBudgetTemplate)) {
return false;
}
PrivacyBudgetTemplate other = (PrivacyBudgetTemplate) obj;
return Objects.equals(id(), other.id()) && Objects.equals(arn(), other.arn())
&& Objects.equals(membershipId(), other.membershipId()) && Objects.equals(membershipArn(), other.membershipArn())
&& Objects.equals(collaborationId(), other.collaborationId())
&& Objects.equals(collaborationArn(), other.collaborationArn())
&& Objects.equals(createTime(), other.createTime()) && Objects.equals(updateTime(), other.updateTime())
&& Objects.equals(privacyBudgetTypeAsString(), other.privacyBudgetTypeAsString())
&& Objects.equals(autoRefreshAsString(), other.autoRefreshAsString())
&& Objects.equals(parameters(), other.parameters());
}
/**
* 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("PrivacyBudgetTemplate").add("Id", id()).add("Arn", arn()).add("MembershipId", membershipId())
.add("MembershipArn", membershipArn()).add("CollaborationId", collaborationId())
.add("CollaborationArn", collaborationArn()).add("CreateTime", createTime()).add("UpdateTime", updateTime())
.add("PrivacyBudgetType", privacyBudgetTypeAsString()).add("AutoRefresh", autoRefreshAsString())
.add("Parameters", parameters()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "id":
return Optional.ofNullable(clazz.cast(id()));
case "arn":
return Optional.ofNullable(clazz.cast(arn()));
case "membershipId":
return Optional.ofNullable(clazz.cast(membershipId()));
case "membershipArn":
return Optional.ofNullable(clazz.cast(membershipArn()));
case "collaborationId":
return Optional.ofNullable(clazz.cast(collaborationId()));
case "collaborationArn":
return Optional.ofNullable(clazz.cast(collaborationArn()));
case "createTime":
return Optional.ofNullable(clazz.cast(createTime()));
case "updateTime":
return Optional.ofNullable(clazz.cast(updateTime()));
case "privacyBudgetType":
return Optional.ofNullable(clazz.cast(privacyBudgetTypeAsString()));
case "autoRefresh":
return Optional.ofNullable(clazz.cast(autoRefreshAsString()));
case "parameters":
return Optional.ofNullable(clazz.cast(parameters()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function