software.amazon.awssdk.services.codeartifact.model.CreateDomainRequest Maven / Gradle / Ivy
Show all versions of codeartifact 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.codeartifact.model;
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.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.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateDomainRequest extends CodeartifactRequest implements
ToCopyableBuilder {
private static final SdkField DOMAIN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("domain")
.getter(getter(CreateDomainRequest::domain)).setter(setter(Builder::domain))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("domain").build()).build();
private static final SdkField ENCRYPTION_KEY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("encryptionKey").getter(getter(CreateDomainRequest::encryptionKey))
.setter(setter(Builder::encryptionKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("encryptionKey").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("tags")
.getter(getter(CreateDomainRequest::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(DOMAIN_FIELD,
ENCRYPTION_KEY_FIELD, TAGS_FIELD));
private final String domain;
private final String encryptionKey;
private final List tags;
private CreateDomainRequest(BuilderImpl builder) {
super(builder);
this.domain = builder.domain;
this.encryptionKey = builder.encryptionKey;
this.tags = builder.tags;
}
/**
*
* The name of the domain to create. All domain names in an Amazon Web Services Region that are in the same Amazon
* Web Services account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive
* information in a domain name because it is publicly discoverable.
*
*
* @return The name of the domain to create. All domain names in an Amazon Web Services Region that are in the same
* Amazon Web Services account must be unique. The domain name is used as the prefix in DNS hostnames. Do
* not use sensitive information in a domain name because it is publicly discoverable.
*/
public final String domain() {
return domain;
}
/**
*
* The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can be a
* key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an
* encryptionKey, your IAM role must have kms:DescribeKey and kms:CreateGrant
* permissions on the encryption key that is used. For more information, see DescribeKey in the Key Management Service API Reference and Key Management
* Service API Permissions Reference in the Key Management Service Developer Guide.
*
*
*
* CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more
* information, see Using
* symmetric and asymmetric keys in the Key Management Service Developer Guide.
*
*
*
* @return The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key
* can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an
* encryptionKey, your IAM role must have kms:DescribeKey and
* kms:CreateGrant permissions on the encryption key that is used. For more information, see DescribeKey in the Key Management Service API Reference and Key
* Management Service API Permissions Reference in the Key Management Service Developer Guide.
*
*
* CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more
* information, see Using symmetric
* and asymmetric keys in the Key Management Service Developer Guide.
*
*/
public final String encryptionKey() {
return encryptionKey;
}
/**
* 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);
}
/**
*
* One or more tag key-value pairs for the domain.
*
*
* 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 One or more tag key-value pairs for the domain.
*/
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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(domain());
hashCode = 31 * hashCode + Objects.hashCode(encryptionKey());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
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 CreateDomainRequest)) {
return false;
}
CreateDomainRequest other = (CreateDomainRequest) obj;
return Objects.equals(domain(), other.domain()) && Objects.equals(encryptionKey(), other.encryptionKey())
&& 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("CreateDomainRequest").add("Domain", domain()).add("EncryptionKey", encryptionKey())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "domain":
return Optional.ofNullable(clazz.cast(domain()));
case "encryptionKey":
return Optional.ofNullable(clazz.cast(encryptionKey()));
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((CreateDomainRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CodeartifactRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the domain to create. All domain names in an Amazon Web Services Region that are in the same
* Amazon Web Services account must be unique. The domain name is used as the prefix in DNS hostnames. Do not
* use sensitive information in a domain name because it is publicly discoverable.
*
*
* @param domain
* The name of the domain to create. All domain names in an Amazon Web Services Region that are in the
* same Amazon Web Services account must be unique. The domain name is used as the prefix in DNS
* hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder domain(String domain);
/**
*
* The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can
* be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an
* encryptionKey, your IAM role must have kms:DescribeKey and
* kms:CreateGrant permissions on the encryption key that is used. For more information, see
* DescribeKey in the Key Management Service API Reference and Key
* Management Service API Permissions Reference in the Key Management Service Developer Guide.
*
*
*
* CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more
* information, see Using symmetric and
* asymmetric keys in the Key Management Service Developer Guide.
*
*
*
* @param encryptionKey
* The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption
* key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an
* encryptionKey, your IAM role must have kms:DescribeKey and
* kms:CreateGrant permissions on the encryption key that is used. For more information, see
* DescribeKey in the Key Management Service API Reference and Key
* Management Service API Permissions Reference in the Key Management Service Developer Guide.
*
*
* CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For
* more information, see Using symmetric
* and asymmetric keys in the Key Management Service Developer Guide.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder encryptionKey(String encryptionKey);
/**
*
* One or more tag key-value pairs for the domain.
*
*
* @param tags
* One or more tag key-value pairs for the domain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* One or more tag key-value pairs for the domain.
*
*
* @param tags
* One or more tag key-value pairs for the domain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* One or more tag key-value pairs for the domain.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.codeartifact.model.Tag.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.codeartifact.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.codeartifact.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.codeartifact.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);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CodeartifactRequest.BuilderImpl implements Builder {
private String domain;
private String encryptionKey;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateDomainRequest model) {
super(model);
domain(model.domain);
encryptionKey(model.encryptionKey);
tags(model.tags);
}
public final String getDomain() {
return domain;
}
public final void setDomain(String domain) {
this.domain = domain;
}
@Override
public final Builder domain(String domain) {
this.domain = domain;
return this;
}
public final String getEncryptionKey() {
return encryptionKey;
}
public final void setEncryptionKey(String encryptionKey) {
this.encryptionKey = encryptionKey;
}
@Override
public final Builder encryptionKey(String encryptionKey) {
this.encryptionKey = encryptionKey;
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 Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateDomainRequest build() {
return new CreateDomainRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}