software.amazon.awssdk.services.ec2.model.CreateIpamScopeRequest Maven / Gradle / Ivy
Show all versions of ec2 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.ec2.model;
import java.util.Arrays;
import java.util.Collection;
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 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.DefaultValueTrait;
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 CreateIpamScopeRequest extends Ec2Request implements
ToCopyableBuilder {
private static final SdkField DRY_RUN_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("DryRun")
.getter(getter(CreateIpamScopeRequest::dryRun))
.setter(setter(Builder::dryRun))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DryRun")
.unmarshallLocationName("DryRun").build()).build();
private static final SdkField IPAM_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("IpamId")
.getter(getter(CreateIpamScopeRequest::ipamId))
.setter(setter(Builder::ipamId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IpamId")
.unmarshallLocationName("IpamId").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Description")
.getter(getter(CreateIpamScopeRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description")
.unmarshallLocationName("Description").build()).build();
private static final SdkField> TAG_SPECIFICATIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("TagSpecifications")
.getter(getter(CreateIpamScopeRequest::tagSpecifications))
.setter(setter(Builder::tagSpecifications))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TagSpecification")
.unmarshallLocationName("TagSpecification").build(),
ListTrait
.builder()
.memberLocationName("item")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(TagSpecification::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Item").unmarshallLocationName("item").build()).build())
.build()).build();
private static final SdkField CLIENT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ClientToken")
.getter(getter(CreateIpamScopeRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClientToken")
.unmarshallLocationName("ClientToken").build(), DefaultValueTrait.idempotencyToken()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DRY_RUN_FIELD, IPAM_ID_FIELD,
DESCRIPTION_FIELD, TAG_SPECIFICATIONS_FIELD, CLIENT_TOKEN_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("DryRun", DRY_RUN_FIELD);
put("IpamId", IPAM_ID_FIELD);
put("Description", DESCRIPTION_FIELD);
put("TagSpecification", TAG_SPECIFICATIONS_FIELD);
put("ClientToken", CLIENT_TOKEN_FIELD);
}
});
private final Boolean dryRun;
private final String ipamId;
private final String description;
private final List tagSpecifications;
private final String clientToken;
private CreateIpamScopeRequest(BuilderImpl builder) {
super(builder);
this.dryRun = builder.dryRun;
this.ipamId = builder.ipamId;
this.description = builder.description;
this.tagSpecifications = builder.tagSpecifications;
this.clientToken = builder.clientToken;
}
/**
*
* A check for whether you have the required permissions for the action without actually making the request and
* provides an error response. If you have the required permissions, the error response is
* DryRunOperation. Otherwise, it is UnauthorizedOperation.
*
*
* @return A check for whether you have the required permissions for the action without actually making the request
* and provides an error response. If you have the required permissions, the error response is
* DryRunOperation. Otherwise, it is UnauthorizedOperation.
*/
public final Boolean dryRun() {
return dryRun;
}
/**
*
* The ID of the IPAM for which you're creating this scope.
*
*
* @return The ID of the IPAM for which you're creating this scope.
*/
public final String ipamId() {
return ipamId;
}
/**
*
* A description for the scope you're creating.
*
*
* @return A description for the scope you're creating.
*/
public final String description() {
return description;
}
/**
* For responses, this returns true if the service returned a value for the TagSpecifications 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 hasTagSpecifications() {
return tagSpecifications != null && !(tagSpecifications instanceof SdkAutoConstructList);
}
/**
*
* The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value
* as the filter value. For example, to find all resources that have a tag with the key Owner and the
* value TeamA, specify tag:Owner for the filter name and TeamA for the
* filter value.
*
*
* 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 #hasTagSpecifications} method.
*
*
* @return The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the
* tag value as the filter value. For example, to find all resources that have a tag with the key
* Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*/
public final List tagSpecifications() {
return tagSpecifications;
}
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring
* idempotency.
*
*
* @return A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring idempotency.
*/
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(dryRun());
hashCode = 31 * hashCode + Objects.hashCode(ipamId());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(hasTagSpecifications() ? tagSpecifications() : null);
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 CreateIpamScopeRequest)) {
return false;
}
CreateIpamScopeRequest other = (CreateIpamScopeRequest) obj;
return Objects.equals(dryRun(), other.dryRun()) && Objects.equals(ipamId(), other.ipamId())
&& Objects.equals(description(), other.description()) && hasTagSpecifications() == other.hasTagSpecifications()
&& Objects.equals(tagSpecifications(), other.tagSpecifications())
&& 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("CreateIpamScopeRequest").add("DryRun", dryRun()).add("IpamId", ipamId())
.add("Description", description()).add("TagSpecifications", hasTagSpecifications() ? tagSpecifications() : null)
.add("ClientToken", clientToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DryRun":
return Optional.ofNullable(clazz.cast(dryRun()));
case "IpamId":
return Optional.ofNullable(clazz.cast(ipamId()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "TagSpecifications":
return Optional.ofNullable(clazz.cast(tagSpecifications()));
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 Function getter(Function g) {
return obj -> g.apply((CreateIpamScopeRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder {
/**
*
* A check for whether you have the required permissions for the action without actually making the request and
* provides an error response. If you have the required permissions, the error response is
* DryRunOperation. Otherwise, it is UnauthorizedOperation.
*
*
* @param dryRun
* A check for whether you have the required permissions for the action without actually making the
* request and provides an error response. If you have the required permissions, the error response is
* DryRunOperation. Otherwise, it is UnauthorizedOperation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dryRun(Boolean dryRun);
/**
*
* The ID of the IPAM for which you're creating this scope.
*
*
* @param ipamId
* The ID of the IPAM for which you're creating this scope.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ipamId(String ipamId);
/**
*
* A description for the scope you're creating.
*
*
* @param description
* A description for the scope you're creating.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag
* value as the filter value. For example, to find all resources that have a tag with the key Owner
* and the value TeamA, specify tag:Owner for the filter name and TeamA
* for the filter value.
*
*
* @param tagSpecifications
* The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and
* the tag value as the filter value. For example, to find all resources that have a tag with the key
* Owner and the value TeamA, specify tag:Owner for the filter
* name and TeamA for the filter value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tagSpecifications(Collection tagSpecifications);
/**
*
* The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag
* value as the filter value. For example, to find all resources that have a tag with the key Owner
* and the value TeamA, specify tag:Owner for the filter name and TeamA
* for the filter value.
*
*
* @param tagSpecifications
* The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and
* the tag value as the filter value. For example, to find all resources that have a tag with the key
* Owner and the value TeamA, specify tag:Owner for the filter
* name and TeamA for the filter value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tagSpecifications(TagSpecification... tagSpecifications);
/**
*
* The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag
* value as the filter value. For example, to find all resources that have a tag with the key Owner
* and the value TeamA, specify tag:Owner for the filter name and TeamA
* for the filter value.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ec2.model.TagSpecification.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.ec2.model.TagSpecification#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.ec2.model.TagSpecification.Builder#build()} is called immediately and
* its result is passed to {@link #tagSpecifications(List)}.
*
* @param tagSpecifications
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.ec2.model.TagSpecification.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tagSpecifications(java.util.Collection)
*/
Builder tagSpecifications(Consumer... tagSpecifications);
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see Ensuring
* idempotency.
*
*
* @param clientToken
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For
* more information, see Ensuring
* idempotency.
* @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 Ec2Request.BuilderImpl implements Builder {
private Boolean dryRun;
private String ipamId;
private String description;
private List tagSpecifications = DefaultSdkAutoConstructList.getInstance();
private String clientToken;
private BuilderImpl() {
}
private BuilderImpl(CreateIpamScopeRequest model) {
super(model);
dryRun(model.dryRun);
ipamId(model.ipamId);
description(model.description);
tagSpecifications(model.tagSpecifications);
clientToken(model.clientToken);
}
public final Boolean getDryRun() {
return dryRun;
}
public final void setDryRun(Boolean dryRun) {
this.dryRun = dryRun;
}
@Override
public final Builder dryRun(Boolean dryRun) {
this.dryRun = dryRun;
return this;
}
public final String getIpamId() {
return ipamId;
}
public final void setIpamId(String ipamId) {
this.ipamId = ipamId;
}
@Override
public final Builder ipamId(String ipamId) {
this.ipamId = ipamId;
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 List getTagSpecifications() {
List result = TagSpecificationListCopier.copyToBuilder(this.tagSpecifications);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTagSpecifications(Collection tagSpecifications) {
this.tagSpecifications = TagSpecificationListCopier.copyFromBuilder(tagSpecifications);
}
@Override
public final Builder tagSpecifications(Collection tagSpecifications) {
this.tagSpecifications = TagSpecificationListCopier.copy(tagSpecifications);
return this;
}
@Override
@SafeVarargs
public final Builder tagSpecifications(TagSpecification... tagSpecifications) {
tagSpecifications(Arrays.asList(tagSpecifications));
return this;
}
@Override
@SafeVarargs
public final Builder tagSpecifications(Consumer... tagSpecifications) {
tagSpecifications(Stream.of(tagSpecifications).map(c -> TagSpecification.builder().applyMutation(c).build())
.collect(Collectors.toList()));
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 CreateIpamScopeRequest build() {
return new CreateIpamScopeRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}