software.amazon.awssdk.services.appmesh.model.CreateVirtualGatewayRequest Maven / Gradle / Ivy
/*
* 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.appmesh.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.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 CreateVirtualGatewayRequest extends AppMeshRequest implements
ToCopyableBuilder {
private static final SdkField CLIENT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("clientToken")
.getter(getter(CreateVirtualGatewayRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("clientToken").build(),
DefaultValueTrait.idempotencyToken()).build();
private static final SdkField MESH_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("meshName").getter(getter(CreateVirtualGatewayRequest::meshName)).setter(setter(Builder::meshName))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("meshName").build()).build();
private static final SdkField MESH_OWNER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("meshOwner").getter(getter(CreateVirtualGatewayRequest::meshOwner)).setter(setter(Builder::meshOwner))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("meshOwner").build()).build();
private static final SdkField SPEC_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("spec")
.getter(getter(CreateVirtualGatewayRequest::spec)).setter(setter(Builder::spec))
.constructor(VirtualGatewaySpec::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("spec").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("tags")
.getter(getter(CreateVirtualGatewayRequest::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(TagRef::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField VIRTUAL_GATEWAY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("virtualGatewayName").getter(getter(CreateVirtualGatewayRequest::virtualGatewayName))
.setter(setter(Builder::virtualGatewayName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("virtualGatewayName").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CLIENT_TOKEN_FIELD,
MESH_NAME_FIELD, MESH_OWNER_FIELD, SPEC_FIELD, TAGS_FIELD, VIRTUAL_GATEWAY_NAME_FIELD));
private final String clientToken;
private final String meshName;
private final String meshOwner;
private final VirtualGatewaySpec spec;
private final List tags;
private final String virtualGatewayName;
private CreateVirtualGatewayRequest(BuilderImpl builder) {
super(builder);
this.clientToken = builder.clientToken;
this.meshName = builder.meshName;
this.meshOwner = builder.meshOwner;
this.spec = builder.spec;
this.tags = builder.tags;
this.virtualGatewayName = builder.virtualGatewayName;
}
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters,
* numbers, hyphens, and underscores are allowed.
*
*
* @return Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36
* letters, numbers, hyphens, and underscores are allowed.
*/
public final String clientToken() {
return clientToken;
}
/**
*
* The name of the service mesh to create the virtual gateway in.
*
*
* @return The name of the service mesh to create the virtual gateway in.
*/
public final String meshName() {
return meshName;
}
/**
*
* The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the
* account that you specify must share the mesh with your account before you can create the resource in the service
* mesh. For more information about mesh sharing, see Working with shared meshes.
*
*
* @return The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then
* the account that you specify must share the mesh with your account before you can create the resource in
* the service mesh. For more information about mesh sharing, see Working with shared meshes.
*/
public final String meshOwner() {
return meshOwner;
}
/**
*
* The virtual gateway specification to apply.
*
*
* @return The virtual gateway specification to apply.
*/
public final VirtualGatewaySpec spec() {
return spec;
}
/**
* 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);
}
/**
*
* Optional metadata that you can apply to the virtual gateway to assist with categorization and organization. Each
* tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character
* length of 128 characters, and tag values can have a maximum length of 256 characters.
*
*
* 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 Optional metadata that you can apply to the virtual gateway to assist with categorization and
* organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can
* have a maximum character length of 128 characters, and tag values can have a maximum length of 256
* characters.
*/
public final List tags() {
return tags;
}
/**
*
* The name to use for the virtual gateway.
*
*
* @return The name to use for the virtual gateway.
*/
public final String virtualGatewayName() {
return virtualGatewayName;
}
@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(clientToken());
hashCode = 31 * hashCode + Objects.hashCode(meshName());
hashCode = 31 * hashCode + Objects.hashCode(meshOwner());
hashCode = 31 * hashCode + Objects.hashCode(spec());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(virtualGatewayName());
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 CreateVirtualGatewayRequest)) {
return false;
}
CreateVirtualGatewayRequest other = (CreateVirtualGatewayRequest) obj;
return Objects.equals(clientToken(), other.clientToken()) && Objects.equals(meshName(), other.meshName())
&& Objects.equals(meshOwner(), other.meshOwner()) && Objects.equals(spec(), other.spec())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags())
&& Objects.equals(virtualGatewayName(), other.virtualGatewayName());
}
/**
* 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("CreateVirtualGatewayRequest").add("ClientToken", clientToken()).add("MeshName", meshName())
.add("MeshOwner", meshOwner()).add("Spec", spec()).add("Tags", hasTags() ? tags() : null)
.add("VirtualGatewayName", virtualGatewayName()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "clientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
case "meshName":
return Optional.ofNullable(clazz.cast(meshName()));
case "meshOwner":
return Optional.ofNullable(clazz.cast(meshOwner()));
case "spec":
return Optional.ofNullable(clazz.cast(spec()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
case "virtualGatewayName":
return Optional.ofNullable(clazz.cast(virtualGatewayName()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateVirtualGatewayRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends AppMeshRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36
* letters, numbers, hyphens, and underscores are allowed.
*
*
* @param clientToken
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36
* letters, numbers, hyphens, and underscores are allowed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientToken(String clientToken);
/**
*
* The name of the service mesh to create the virtual gateway in.
*
*
* @param meshName
* The name of the service mesh to create the virtual gateway in.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder meshName(String meshName);
/**
*
* The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the
* account that you specify must share the mesh with your account before you can create the resource in the
* service mesh. For more information about mesh sharing, see Working with shared meshes.
*
*
* @param meshOwner
* The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own,
* then the account that you specify must share the mesh with your account before you can create the
* resource in the service mesh. For more information about mesh sharing, see Working with shared
* meshes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder meshOwner(String meshOwner);
/**
*
* The virtual gateway specification to apply.
*
*
* @param spec
* The virtual gateway specification to apply.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder spec(VirtualGatewaySpec spec);
/**
*
* The virtual gateway specification to apply.
*
* This is a convenience method that creates an instance of the {@link VirtualGatewaySpec.Builder} avoiding the
* need to create one manually via {@link VirtualGatewaySpec#builder()}.
*
*
* When the {@link Consumer} completes, {@link VirtualGatewaySpec.Builder#build()} is called immediately and its
* result is passed to {@link #spec(VirtualGatewaySpec)}.
*
* @param spec
* a consumer that will call methods on {@link VirtualGatewaySpec.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #spec(VirtualGatewaySpec)
*/
default Builder spec(Consumer spec) {
return spec(VirtualGatewaySpec.builder().applyMutation(spec).build());
}
/**
*
* Optional metadata that you can apply to the virtual gateway to assist with categorization and organization.
* Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum
* character length of 128 characters, and tag values can have a maximum length of 256 characters.
*
*
* @param tags
* Optional metadata that you can apply to the virtual gateway to assist with categorization and
* organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can
* have a maximum character length of 128 characters, and tag values can have a maximum length of 256
* characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* Optional metadata that you can apply to the virtual gateway to assist with categorization and organization.
* Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum
* character length of 128 characters, and tag values can have a maximum length of 256 characters.
*
*
* @param tags
* Optional metadata that you can apply to the virtual gateway to assist with categorization and
* organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can
* have a maximum character length of 128 characters, and tag values can have a maximum length of 256
* characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(TagRef... tags);
/**
*
* Optional metadata that you can apply to the virtual gateway to assist with categorization and organization.
* Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum
* character length of 128 characters, and tag values can have a maximum length of 256 characters.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.appmesh.model.TagRef.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.appmesh.model.TagRef#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.appmesh.model.TagRef.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.appmesh.model.TagRef.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);
/**
*
* The name to use for the virtual gateway.
*
*
* @param virtualGatewayName
* The name to use for the virtual gateway.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder virtualGatewayName(String virtualGatewayName);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends AppMeshRequest.BuilderImpl implements Builder {
private String clientToken;
private String meshName;
private String meshOwner;
private VirtualGatewaySpec spec;
private List tags = DefaultSdkAutoConstructList.getInstance();
private String virtualGatewayName;
private BuilderImpl() {
}
private BuilderImpl(CreateVirtualGatewayRequest model) {
super(model);
clientToken(model.clientToken);
meshName(model.meshName);
meshOwner(model.meshOwner);
spec(model.spec);
tags(model.tags);
virtualGatewayName(model.virtualGatewayName);
}
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;
}
public final String getMeshName() {
return meshName;
}
public final void setMeshName(String meshName) {
this.meshName = meshName;
}
@Override
public final Builder meshName(String meshName) {
this.meshName = meshName;
return this;
}
public final String getMeshOwner() {
return meshOwner;
}
public final void setMeshOwner(String meshOwner) {
this.meshOwner = meshOwner;
}
@Override
public final Builder meshOwner(String meshOwner) {
this.meshOwner = meshOwner;
return this;
}
public final VirtualGatewaySpec.Builder getSpec() {
return spec != null ? spec.toBuilder() : null;
}
public final void setSpec(VirtualGatewaySpec.BuilderImpl spec) {
this.spec = spec != null ? spec.build() : null;
}
@Override
public final Builder spec(VirtualGatewaySpec spec) {
this.spec = spec;
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(TagRef... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> TagRef.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getVirtualGatewayName() {
return virtualGatewayName;
}
public final void setVirtualGatewayName(String virtualGatewayName) {
this.virtualGatewayName = virtualGatewayName;
}
@Override
public final Builder virtualGatewayName(String virtualGatewayName) {
this.virtualGatewayName = virtualGatewayName;
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 CreateVirtualGatewayRequest build() {
return new CreateVirtualGatewayRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}