software.amazon.awssdk.services.glue.model.CreateDataQualityRulesetRequest Maven / Gradle / Ivy
Show all versions of glue 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.glue.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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.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.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
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 CreateDataQualityRulesetRequest extends GlueRequest implements
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(CreateDataQualityRulesetRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(CreateDataQualityRulesetRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField RULESET_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Ruleset")
.getter(getter(CreateDataQualityRulesetRequest::ruleset)).setter(setter(Builder::ruleset))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Ruleset").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Tags")
.getter(getter(CreateDataQualityRulesetRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField TARGET_TABLE_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("TargetTable")
.getter(getter(CreateDataQualityRulesetRequest::targetTable)).setter(setter(Builder::targetTable))
.constructor(DataQualityTargetTable::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TargetTable").build()).build();
private static final SdkField DATA_QUALITY_SECURITY_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("DataQualitySecurityConfiguration")
.getter(getter(CreateDataQualityRulesetRequest::dataQualitySecurityConfiguration))
.setter(setter(Builder::dataQualitySecurityConfiguration))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DataQualitySecurityConfiguration")
.build()).build();
private static final SdkField CLIENT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ClientToken").getter(getter(CreateDataQualityRulesetRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClientToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, DESCRIPTION_FIELD,
RULESET_FIELD, TAGS_FIELD, TARGET_TABLE_FIELD, DATA_QUALITY_SECURITY_CONFIGURATION_FIELD, CLIENT_TOKEN_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String name;
private final String description;
private final String ruleset;
private final Map tags;
private final DataQualityTargetTable targetTable;
private final String dataQualitySecurityConfiguration;
private final String clientToken;
private CreateDataQualityRulesetRequest(BuilderImpl builder) {
super(builder);
this.name = builder.name;
this.description = builder.description;
this.ruleset = builder.ruleset;
this.tags = builder.tags;
this.targetTable = builder.targetTable;
this.dataQualitySecurityConfiguration = builder.dataQualitySecurityConfiguration;
this.clientToken = builder.clientToken;
}
/**
*
* A unique name for the data quality ruleset.
*
*
* @return A unique name for the data quality ruleset.
*/
public final String name() {
return name;
}
/**
*
* A description of the data quality ruleset.
*
*
* @return A description of the data quality ruleset.
*/
public final String description() {
return description;
}
/**
*
* A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
*
*
* @return A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
*/
public final String ruleset() {
return ruleset;
}
/**
* 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 SdkAutoConstructMap);
}
/**
*
* A list of tags applied to the data quality ruleset.
*
*
* 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 tags applied to the data quality ruleset.
*/
public final Map tags() {
return tags;
}
/**
*
* A target table associated with the data quality ruleset.
*
*
* @return A target table associated with the data quality ruleset.
*/
public final DataQualityTargetTable targetTable() {
return targetTable;
}
/**
*
* The name of the security configuration created with the data quality encryption option.
*
*
* @return The name of the security configuration created with the data quality encryption option.
*/
public final String dataQualitySecurityConfiguration() {
return dataQualitySecurityConfiguration;
}
/**
*
* Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting
* multiple instances of the same resource.
*
*
* @return Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or
* starting multiple instances of the same resource.
*/
public final String clientToken() {
return clientToken;
}
@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(name());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(ruleset());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(targetTable());
hashCode = 31 * hashCode + Objects.hashCode(dataQualitySecurityConfiguration());
hashCode = 31 * hashCode + Objects.hashCode(clientToken());
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 CreateDataQualityRulesetRequest)) {
return false;
}
CreateDataQualityRulesetRequest other = (CreateDataQualityRulesetRequest) obj;
return Objects.equals(name(), other.name()) && Objects.equals(description(), other.description())
&& Objects.equals(ruleset(), other.ruleset()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags()) && Objects.equals(targetTable(), other.targetTable())
&& Objects.equals(dataQualitySecurityConfiguration(), other.dataQualitySecurityConfiguration())
&& Objects.equals(clientToken(), other.clientToken());
}
/**
* 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("CreateDataQualityRulesetRequest").add("Name", name()).add("Description", description())
.add("Ruleset", ruleset()).add("Tags", hasTags() ? tags() : null).add("TargetTable", targetTable())
.add("DataQualitySecurityConfiguration", dataQualitySecurityConfiguration()).add("ClientToken", clientToken())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "Ruleset":
return Optional.ofNullable(clazz.cast(ruleset()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
case "TargetTable":
return Optional.ofNullable(clazz.cast(targetTable()));
case "DataQualitySecurityConfiguration":
return Optional.ofNullable(clazz.cast(dataQualitySecurityConfiguration()));
case "ClientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("Name", NAME_FIELD);
map.put("Description", DESCRIPTION_FIELD);
map.put("Ruleset", RULESET_FIELD);
map.put("Tags", TAGS_FIELD);
map.put("TargetTable", TARGET_TABLE_FIELD);
map.put("DataQualitySecurityConfiguration", DATA_QUALITY_SECURITY_CONFIGURATION_FIELD);
map.put("ClientToken", CLIENT_TOKEN_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((CreateDataQualityRulesetRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends GlueRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* A unique name for the data quality ruleset.
*
*
* @param name
* A unique name for the data quality ruleset.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* A description of the data quality ruleset.
*
*
* @param description
* A description of the data quality ruleset.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
*
*
* @param ruleset
* A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ruleset(String ruleset);
/**
*
* A list of tags applied to the data quality ruleset.
*
*
* @param tags
* A list of tags applied to the data quality ruleset.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
/**
*
* A target table associated with the data quality ruleset.
*
*
* @param targetTable
* A target table associated with the data quality ruleset.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetTable(DataQualityTargetTable targetTable);
/**
*
* A target table associated with the data quality ruleset.
*
* This is a convenience method that creates an instance of the {@link DataQualityTargetTable.Builder} avoiding
* the need to create one manually via {@link DataQualityTargetTable#builder()}.
*
*
* When the {@link Consumer} completes, {@link DataQualityTargetTable.Builder#build()} is called immediately and
* its result is passed to {@link #targetTable(DataQualityTargetTable)}.
*
* @param targetTable
* a consumer that will call methods on {@link DataQualityTargetTable.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #targetTable(DataQualityTargetTable)
*/
default Builder targetTable(Consumer targetTable) {
return targetTable(DataQualityTargetTable.builder().applyMutation(targetTable).build());
}
/**
*
* The name of the security configuration created with the data quality encryption option.
*
*
* @param dataQualitySecurityConfiguration
* The name of the security configuration created with the data quality encryption option.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dataQualitySecurityConfiguration(String dataQualitySecurityConfiguration);
/**
*
* Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or
* starting multiple instances of the same resource.
*
*
* @param clientToken
* Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or
* starting multiple instances of the same resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientToken(String clientToken);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends GlueRequest.BuilderImpl implements Builder {
private String name;
private String description;
private String ruleset;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private DataQualityTargetTable targetTable;
private String dataQualitySecurityConfiguration;
private String clientToken;
private BuilderImpl() {
}
private BuilderImpl(CreateDataQualityRulesetRequest model) {
super(model);
name(model.name);
description(model.description);
ruleset(model.ruleset);
tags(model.tags);
targetTable(model.targetTable);
dataQualitySecurityConfiguration(model.dataQualitySecurityConfiguration);
clientToken(model.clientToken);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final String getRuleset() {
return ruleset;
}
public final void setRuleset(String ruleset) {
this.ruleset = ruleset;
}
@Override
public final Builder ruleset(String ruleset) {
this.ruleset = ruleset;
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagsMapCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = TagsMapCopier.copy(tags);
return this;
}
public final DataQualityTargetTable.Builder getTargetTable() {
return targetTable != null ? targetTable.toBuilder() : null;
}
public final void setTargetTable(DataQualityTargetTable.BuilderImpl targetTable) {
this.targetTable = targetTable != null ? targetTable.build() : null;
}
@Override
public final Builder targetTable(DataQualityTargetTable targetTable) {
this.targetTable = targetTable;
return this;
}
public final String getDataQualitySecurityConfiguration() {
return dataQualitySecurityConfiguration;
}
public final void setDataQualitySecurityConfiguration(String dataQualitySecurityConfiguration) {
this.dataQualitySecurityConfiguration = dataQualitySecurityConfiguration;
}
@Override
public final Builder dataQualitySecurityConfiguration(String dataQualitySecurityConfiguration) {
this.dataQualitySecurityConfiguration = dataQualitySecurityConfiguration;
return this;
}
public final String getClientToken() {
return clientToken;
}
public final void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
@Override
public final Builder clientToken(String clientToken) {
this.clientToken = clientToken;
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 CreateDataQualityRulesetRequest build() {
return new CreateDataQualityRulesetRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}