software.amazon.awssdk.services.appmesh.model.CreateRouteRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of appmesh Show documentation
Show all versions of appmesh Show documentation
The AWS Java SDK for App Mesh module holds the client classes that are used for
communicating with App Mesh.
/*
* 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;
/**
* {
private static final SdkField CLIENT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("clientToken")
.getter(getter(CreateRouteRequest::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(CreateRouteRequest::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(CreateRouteRequest::meshOwner)).setter(setter(Builder::meshOwner))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("meshOwner").build()).build();
private static final SdkField ROUTE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("routeName").getter(getter(CreateRouteRequest::routeName)).setter(setter(Builder::routeName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("routeName").build()).build();
private static final SdkField SPEC_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("spec").getter(getter(CreateRouteRequest::spec)).setter(setter(Builder::spec))
.constructor(RouteSpec::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(CreateRouteRequest::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_ROUTER_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("virtualRouterName").getter(getter(CreateRouteRequest::virtualRouterName))
.setter(setter(Builder::virtualRouterName))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("virtualRouterName").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CLIENT_TOKEN_FIELD,
MESH_NAME_FIELD, MESH_OWNER_FIELD, ROUTE_NAME_FIELD, SPEC_FIELD, TAGS_FIELD, VIRTUAL_ROUTER_NAME_FIELD));
private final String clientToken;
private final String meshName;
private final String meshOwner;
private final String routeName;
private final RouteSpec spec;
private final List tags;
private final String virtualRouterName;
private CreateRouteRequest(BuilderImpl builder) {
super(builder);
this.clientToken = builder.clientToken;
this.meshName = builder.meshName;
this.meshOwner = builder.meshOwner;
this.routeName = builder.routeName;
this.spec = builder.spec;
this.tags = builder.tags;
this.virtualRouterName = builder.virtualRouterName;
}
/**
*
* 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 route in.
*
*
* @return The name of the service mesh to create the route in.
*/
public final String meshName() {
return meshName;
}
/**
*
* The AWS 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 AWS 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 name to use for the route.
*
*
* @return The name to use for the route.
*/
public final String routeName() {
return routeName;
}
/**
*
* The route specification to apply.
*
*
* @return The route specification to apply.
*/
public final RouteSpec spec() {
return spec;
}
/**
* Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
* specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* Optional metadata that you can apply to the route 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.
*
*
* You can use {@link #hasTags()} to see if a value was sent in this field.
*
*
* @return Optional metadata that you can apply to the route 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 of the virtual router in which to create the route. If the virtual router is in a shared mesh, then you
* must be the owner of the virtual router resource.
*
*
* @return The name of the virtual router in which to create the route. If the virtual router is in a shared mesh,
* then you must be the owner of the virtual router resource.
*/
public final String virtualRouterName() {
return virtualRouterName;
}
@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(routeName());
hashCode = 31 * hashCode + Objects.hashCode(spec());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(virtualRouterName());
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 CreateRouteRequest)) {
return false;
}
CreateRouteRequest other = (CreateRouteRequest) obj;
return Objects.equals(clientToken(), other.clientToken()) && Objects.equals(meshName(), other.meshName())
&& Objects.equals(meshOwner(), other.meshOwner()) && Objects.equals(routeName(), other.routeName())
&& Objects.equals(spec(), other.spec()) && hasTags() == other.hasTags() && Objects.equals(tags(), other.tags())
&& Objects.equals(virtualRouterName(), other.virtualRouterName());
}
/**
* 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("CreateRouteRequest").add("ClientToken", clientToken()).add("MeshName", meshName())
.add("MeshOwner", meshOwner()).add("RouteName", routeName()).add("Spec", spec())
.add("Tags", hasTags() ? tags() : null).add("VirtualRouterName", virtualRouterName()).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 "routeName":
return Optional.ofNullable(clazz.cast(routeName()));
case "spec":
return Optional.ofNullable(clazz.cast(spec()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
case "virtualRouterName":
return Optional.ofNullable(clazz.cast(virtualRouterName()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateRouteRequest) 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 route in.
*
*
* @param meshName
* The name of the service mesh to create the route in.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder meshName(String meshName);
/**
*
* The AWS 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 AWS 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 name to use for the route.
*
*
* @param routeName
* The name to use for the route.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder routeName(String routeName);
/**
*
* The route specification to apply.
*
*
* @param spec
* The route specification to apply.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder spec(RouteSpec spec);
/**
*
* The route specification to apply.
*
* This is a convenience that creates an instance of the {@link RouteSpec.Builder} avoiding the need to create
* one manually via {@link RouteSpec#builder()}.
*
* When the {@link Consumer} completes, {@link RouteSpec.Builder#build()} is called immediately and its result
* is passed to {@link #spec(RouteSpec)}.
*
* @param spec
* a consumer that will call methods on {@link RouteSpec.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #spec(RouteSpec)
*/
default Builder spec(Consumer spec) {
return spec(RouteSpec.builder().applyMutation(spec).build());
}
/**
*
* Optional metadata that you can apply to the route 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 route 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 route 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 route 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 route 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 that creates an instance of the {@link List.Builder} avoiding the need to
* create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its
* result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(List)
*/
Builder tags(Consumer... tags);
/**
*
* The name of the virtual router in which to create the route. If the virtual router is in a shared mesh, then
* you must be the owner of the virtual router resource.
*
*
* @param virtualRouterName
* The name of the virtual router in which to create the route. If the virtual router is in a shared
* mesh, then you must be the owner of the virtual router resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder virtualRouterName(String virtualRouterName);
@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 String routeName;
private RouteSpec spec;
private List tags = DefaultSdkAutoConstructList.getInstance();
private String virtualRouterName;
private BuilderImpl() {
}
private BuilderImpl(CreateRouteRequest model) {
super(model);
clientToken(model.clientToken);
meshName(model.meshName);
meshOwner(model.meshOwner);
routeName(model.routeName);
spec(model.spec);
tags(model.tags);
virtualRouterName(model.virtualRouterName);
}
public final String getClientToken() {
return clientToken;
}
@Override
public final Builder clientToken(String clientToken) {
this.clientToken = clientToken;
return this;
}
public final void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
public final String getMeshName() {
return meshName;
}
@Override
public final Builder meshName(String meshName) {
this.meshName = meshName;
return this;
}
public final void setMeshName(String meshName) {
this.meshName = meshName;
}
public final String getMeshOwner() {
return meshOwner;
}
@Override
public final Builder meshOwner(String meshOwner) {
this.meshOwner = meshOwner;
return this;
}
public final void setMeshOwner(String meshOwner) {
this.meshOwner = meshOwner;
}
public final String getRouteName() {
return routeName;
}
@Override
public final Builder routeName(String routeName) {
this.routeName = routeName;
return this;
}
public final void setRouteName(String routeName) {
this.routeName = routeName;
}
public final RouteSpec.Builder getSpec() {
return spec != null ? spec.toBuilder() : null;
}
@Override
public final Builder spec(RouteSpec spec) {
this.spec = spec;
return this;
}
public final void setSpec(RouteSpec.BuilderImpl spec) {
this.spec = spec != null ? spec.build() : null;
}
public final Collection getTags() {
if (tags instanceof SdkAutoConstructList) {
return null;
}
return tags != null ? tags.stream().map(TagRef::toBuilder).collect(Collectors.toList()) : null;
}
@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 void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
public final String getVirtualRouterName() {
return virtualRouterName;
}
@Override
public final Builder virtualRouterName(String virtualRouterName) {
this.virtualRouterName = virtualRouterName;
return this;
}
public final void setVirtualRouterName(String virtualRouterName) {
this.virtualRouterName = virtualRouterName;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateRouteRequest build() {
return new CreateRouteRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}