software.amazon.awssdk.services.location.model.CreateRouteCalculatorRequest 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.location.model;
import java.beans.Transient;
import java.util.Arrays;
import java.util.Collections;
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 CreateRouteCalculatorRequest extends LocationRequest implements
ToCopyableBuilder {
private static final SdkField CALCULATOR_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CalculatorName").getter(getter(CreateRouteCalculatorRequest::calculatorName))
.setter(setter(Builder::calculatorName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CalculatorName").build()).build();
private static final SdkField DATA_SOURCE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DataSource").getter(getter(CreateRouteCalculatorRequest::dataSource))
.setter(setter(Builder::dataSource))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DataSource").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(CreateRouteCalculatorRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField PRICING_PLAN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PricingPlan").getter(getter(CreateRouteCalculatorRequest::pricingPlanAsString))
.setter(setter(Builder::pricingPlan))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PricingPlan").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Tags")
.getter(getter(CreateRouteCalculatorRequest::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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CALCULATOR_NAME_FIELD,
DATA_SOURCE_FIELD, DESCRIPTION_FIELD, PRICING_PLAN_FIELD, TAGS_FIELD));
private final String calculatorName;
private final String dataSource;
private final String description;
private final String pricingPlan;
private final Map tags;
private CreateRouteCalculatorRequest(BuilderImpl builder) {
super(builder);
this.calculatorName = builder.calculatorName;
this.dataSource = builder.dataSource;
this.description = builder.description;
this.pricingPlan = builder.pricingPlan;
this.tags = builder.tags;
}
/**
*
* The name of the route calculator resource.
*
*
* Requirements:
*
*
* -
*
* Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique Route calculator resource name.
*
*
* -
*
* No spaces allowed. For example, ExampleRouteCalculator.
*
*
*
*
* @return The name of the route calculator resource.
*
* Requirements:
*
*
* -
*
* Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique Route calculator resource name.
*
*
* -
*
* No spaces allowed. For example, ExampleRouteCalculator.
*
*
*/
public final String calculatorName() {
return calculatorName;
}
/**
*
* Specifies the data provider of traffic and road network data.
*
*
*
* This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an
* error. Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km.
*
*
*
* Valid values include:
*
*
* -
*
* Esri – For additional information about Esri's coverage in your region of
* interest, see Esri details on
* street networks and traffic coverage.
*
*
* -
*
* Here – For additional information about HERE Technologies' coverage in
* your region of interest, see HERE car
* routing coverage and HERE
* truck routing coverage.
*
*
*
*
* For additional information , see Data providers
* on the Amazon Location Service Developer Guide.
*
*
* @return Specifies the data provider of traffic and road network data.
*
* This field is case-sensitive. Enter the valid values as shown. For example, entering HERE
* returns an error. Route calculators that use Esri as a data source only calculate routes that are shorter
* than 400 km.
*
*
*
* Valid values include:
*
*
* -
*
* Esri – For additional information about Esri's coverage in your
* region of interest, see Esri details on street
* networks and traffic coverage.
*
*
* -
*
* Here – For additional information about HERE Technologies'
* coverage in your region of interest, see HERE car routing coverage and HERE
* truck routing coverage.
*
*
*
*
* For additional information , see Data
* providers on the Amazon Location Service Developer Guide.
*/
public final String dataSource() {
return dataSource;
}
/**
*
* The optional description for the route calculator resource.
*
*
* @return The optional description for the route calculator resource.
*/
public final String description() {
return description;
}
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #pricingPlan} will
* return {@link PricingPlan#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #pricingPlanAsString}.
*
*
* @return No longer used. If included, the only allowed value is RequestBasedUsage.
* @see PricingPlan
* @deprecated Deprecated. If included, the only allowed value is RequestBasedUsage.
*/
@Deprecated
public final PricingPlan pricingPlan() {
return PricingPlan.fromValue(pricingPlan);
}
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #pricingPlan} will
* return {@link PricingPlan#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #pricingPlanAsString}.
*
*
* @return No longer used. If included, the only allowed value is RequestBasedUsage.
* @see PricingPlan
* @deprecated Deprecated. If included, the only allowed value is RequestBasedUsage.
*/
@Deprecated
public final String pricingPlanAsString() {
return pricingPlan;
}
/**
* 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);
}
/**
*
* Applies one or more tags to the route calculator resource. A tag is a key-value pair helps manage, identify,
* search, and filter your resources by labelling them.
*
*
* -
*
* For example: { "tag1" : "value1", "tag2" : "value2"
*
*
*
*
* Format: "key" : "value"
*
*
* Restrictions:
*
*
* -
*
* Maximum 50 tags per resource
*
*
* -
*
* Each resource tag must be unique with a maximum of one value.
*
*
* -
*
* Maximum key length: 128 Unicode characters in UTF-8
*
*
* -
*
* Maximum value length: 256 Unicode characters in UTF-8
*
*
* -
*
* Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
*
*
* -
*
* Cannot use "aws:" as a prefix for a key.
*
*
*
*
* 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 Applies one or more tags to the route calculator resource. A tag is a key-value pair helps manage,
* identify, search, and filter your resources by labelling them.
*
* -
*
* For example: { "tag1" : "value1", "tag2" : "value2"
*
*
*
*
* Format: "key" : "value"
*
*
* Restrictions:
*
*
* -
*
* Maximum 50 tags per resource
*
*
* -
*
* Each resource tag must be unique with a maximum of one value.
*
*
* -
*
* Maximum key length: 128 Unicode characters in UTF-8
*
*
* -
*
* Maximum value length: 256 Unicode characters in UTF-8
*
*
* -
*
* Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
*
*
* -
*
* Cannot use "aws:" as a prefix for a key.
*
*
*/
public final Map 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(calculatorName());
hashCode = 31 * hashCode + Objects.hashCode(dataSource());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(pricingPlanAsString());
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 CreateRouteCalculatorRequest)) {
return false;
}
CreateRouteCalculatorRequest other = (CreateRouteCalculatorRequest) obj;
return Objects.equals(calculatorName(), other.calculatorName()) && Objects.equals(dataSource(), other.dataSource())
&& Objects.equals(description(), other.description())
&& Objects.equals(pricingPlanAsString(), other.pricingPlanAsString()) && 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("CreateRouteCalculatorRequest").add("CalculatorName", calculatorName())
.add("DataSource", dataSource()).add("Description", description()).add("PricingPlan", pricingPlanAsString())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CalculatorName":
return Optional.ofNullable(clazz.cast(calculatorName()));
case "DataSource":
return Optional.ofNullable(clazz.cast(dataSource()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "PricingPlan":
return Optional.ofNullable(clazz.cast(pricingPlanAsString()));
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((CreateRouteCalculatorRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends LocationRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the route calculator resource.
*
*
* Requirements:
*
*
* -
*
* Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique Route calculator resource name.
*
*
* -
*
* No spaces allowed. For example, ExampleRouteCalculator.
*
*
*
*
* @param calculatorName
* The name of the route calculator resource.
*
* Requirements:
*
*
* -
*
* Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique Route calculator resource name.
*
*
* -
*
* No spaces allowed. For example, ExampleRouteCalculator.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder calculatorName(String calculatorName);
/**
*
* Specifies the data provider of traffic and road network data.
*
*
*
* This field is case-sensitive. Enter the valid values as shown. For example, entering HERE
* returns an error. Route calculators that use Esri as a data source only calculate routes that are shorter
* than 400 km.
*
*
*
* Valid values include:
*
*
* -
*
* Esri – For additional information about Esri's coverage in your
* region of interest, see Esri
* details on street networks and traffic coverage.
*
*
* -
*
* Here – For additional information about HERE Technologies' coverage
* in your region of interest, see HERE
* car routing coverage and HERE
* truck routing coverage.
*
*
*
*
* For additional information , see Data
* providers on the Amazon Location Service Developer Guide.
*
*
* @param dataSource
* Specifies the data provider of traffic and road network data.
*
* This field is case-sensitive. Enter the valid values as shown. For example, entering HERE
* returns an error. Route calculators that use Esri as a data source only calculate routes that are
* shorter than 400 km.
*
*
*
* Valid values include:
*
*
* -
*
* Esri – For additional information about Esri's coverage in
* your region of interest, see Esri details on street
* networks and traffic coverage.
*
*
* -
*
* Here – For additional information about HERE Technologies'
* coverage in your region of interest, see HERE
* car routing coverage and HERE truck routing coverage.
*
*
*
*
* For additional information , see Data
* providers on the Amazon Location Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dataSource(String dataSource);
/**
*
* The optional description for the route calculator resource.
*
*
* @param description
* The optional description for the route calculator resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage.
*
*
* @param pricingPlan
* No longer used. If included, the only allowed value is RequestBasedUsage.
* @see PricingPlan
* @return Returns a reference to this object so that method calls can be chained together.
* @see PricingPlan
* @deprecated Deprecated. If included, the only allowed value is RequestBasedUsage.
*/
@Deprecated
Builder pricingPlan(String pricingPlan);
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage.
*
*
* @param pricingPlan
* No longer used. If included, the only allowed value is RequestBasedUsage.
* @see PricingPlan
* @return Returns a reference to this object so that method calls can be chained together.
* @see PricingPlan
* @deprecated Deprecated. If included, the only allowed value is RequestBasedUsage.
*/
@Deprecated
Builder pricingPlan(PricingPlan pricingPlan);
/**
*
* Applies one or more tags to the route calculator resource. A tag is a key-value pair helps manage, identify,
* search, and filter your resources by labelling them.
*
*
* -
*
* For example: { "tag1" : "value1", "tag2" : "value2"
*
*
*
*
* Format: "key" : "value"
*
*
* Restrictions:
*
*
* -
*
* Maximum 50 tags per resource
*
*
* -
*
* Each resource tag must be unique with a maximum of one value.
*
*
* -
*
* Maximum key length: 128 Unicode characters in UTF-8
*
*
* -
*
* Maximum value length: 256 Unicode characters in UTF-8
*
*
* -
*
* Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
*
*
* -
*
* Cannot use "aws:" as a prefix for a key.
*
*
*
*
* @param tags
* Applies one or more tags to the route calculator resource. A tag is a key-value pair helps manage,
* identify, search, and filter your resources by labelling them.
*
* -
*
* For example: { "tag1" : "value1", "tag2" : "value2"
*
*
*
*
* Format: "key" : "value"
*
*
* Restrictions:
*
*
* -
*
* Maximum 50 tags per resource
*
*
* -
*
* Each resource tag must be unique with a maximum of one value.
*
*
* -
*
* Maximum key length: 128 Unicode characters in UTF-8
*
*
* -
*
* Maximum value length: 256 Unicode characters in UTF-8
*
*
* -
*
* Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
*
*
* -
*
* Cannot use "aws:" as a prefix for a key.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends LocationRequest.BuilderImpl implements Builder {
private String calculatorName;
private String dataSource;
private String description;
private String pricingPlan;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateRouteCalculatorRequest model) {
super(model);
calculatorName(model.calculatorName);
dataSource(model.dataSource);
description(model.description);
pricingPlan(model.pricingPlan);
tags(model.tags);
}
public final String getCalculatorName() {
return calculatorName;
}
public final void setCalculatorName(String calculatorName) {
this.calculatorName = calculatorName;
}
@Override
@Transient
public final Builder calculatorName(String calculatorName) {
this.calculatorName = calculatorName;
return this;
}
public final String getDataSource() {
return dataSource;
}
public final void setDataSource(String dataSource) {
this.dataSource = dataSource;
}
@Override
@Transient
public final Builder dataSource(String dataSource) {
this.dataSource = dataSource;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
@Transient
public final Builder description(String description) {
this.description = description;
return this;
}
@Deprecated
public final String getPricingPlan() {
return pricingPlan;
}
@Deprecated
public final void setPricingPlan(String pricingPlan) {
this.pricingPlan = pricingPlan;
}
@Override
@Transient
@Deprecated
public final Builder pricingPlan(String pricingPlan) {
this.pricingPlan = pricingPlan;
return this;
}
@Override
@Transient
@Deprecated
public final Builder pricingPlan(PricingPlan pricingPlan) {
this.pricingPlan(pricingPlan == null ? null : pricingPlan.toString());
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagMapCopier.copy(tags);
}
@Override
@Transient
public final Builder tags(Map tags) {
this.tags = TagMapCopier.copy(tags);
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 CreateRouteCalculatorRequest build() {
return new CreateRouteCalculatorRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}