software.amazon.awssdk.services.apigateway.model.CreateBasePathMappingRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-gateway Show documentation
Show all versions of api-gateway Show documentation
The AWS Java SDK for Amazon API Gateway module holds the client classes that are used for communicating
with Amazon API
Gateway
/*
* Copyright 2013-2018 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.apigateway.model;
import java.util.Objects;
import java.util.Optional;
import java.util.function.Consumer;
import javax.annotation.Generated;
import software.amazon.awssdk.core.AwsRequestOverrideConfig;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Requests Amazon API Gateway to create a new BasePathMapping resource.
*
*/
@Generated("software.amazon.awssdk:codegen")
public class CreateBasePathMappingRequest extends APIGatewayRequest implements
ToCopyableBuilder {
private final String domainName;
private final String basePath;
private final String restApiId;
private final String stage;
private CreateBasePathMappingRequest(BuilderImpl builder) {
super(builder);
this.domainName = builder.domainName;
this.basePath = builder.basePath;
this.restApiId = builder.restApiId;
this.stage = builder.stage;
}
/**
*
* The domain name of the BasePathMapping resource to create.
*
*
* @return The domain name of the BasePathMapping resource to create.
*/
public String domainName() {
return domainName;
}
/**
*
* The base path name that callers of the API must provide as part of the URL after the domain name. This value must
* be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify a
* base path name after the domain name.
*
*
* @return The base path name that callers of the API must provide as part of the URL after the domain name. This
* value must be unique for all of the mappings across a single API. Leave this blank if you do not want
* callers to specify a base path name after the domain name.
*/
public String basePath() {
return basePath;
}
/**
*
* The string identifier of the associated RestApi.
*
*
* @return The string identifier of the associated RestApi.
*/
public String restApiId() {
return restApiId;
}
/**
*
* The name of the API's stage that you want to use for this mapping. Leave this blank if you do not want callers to
* explicitly specify the stage name after any base path name.
*
*
* @return The name of the API's stage that you want to use for this mapping. Leave this blank if you do not want
* callers to explicitly specify the stage name after any base path name.
*/
public String stage() {
return stage;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(domainName());
hashCode = 31 * hashCode + Objects.hashCode(basePath());
hashCode = 31 * hashCode + Objects.hashCode(restApiId());
hashCode = 31 * hashCode + Objects.hashCode(stage());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateBasePathMappingRequest)) {
return false;
}
CreateBasePathMappingRequest other = (CreateBasePathMappingRequest) obj;
return Objects.equals(domainName(), other.domainName()) && Objects.equals(basePath(), other.basePath())
&& Objects.equals(restApiId(), other.restApiId()) && Objects.equals(stage(), other.stage());
}
@Override
public String toString() {
return ToString.builder("CreateBasePathMappingRequest").add("DomainName", domainName()).add("BasePath", basePath())
.add("RestApiId", restApiId()).add("Stage", stage()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "domainName":
return Optional.of(clazz.cast(domainName()));
case "basePath":
return Optional.of(clazz.cast(basePath()));
case "restApiId":
return Optional.of(clazz.cast(restApiId()));
case "stage":
return Optional.of(clazz.cast(stage()));
default:
return Optional.empty();
}
}
public interface Builder extends APIGatewayRequest.Builder, CopyableBuilder {
/**
*
* The domain name of the BasePathMapping resource to create.
*
*
* @param domainName
* The domain name of the BasePathMapping resource to create.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder domainName(String domainName);
/**
*
* The base path name that callers of the API must provide as part of the URL after the domain name. This value
* must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to
* specify a base path name after the domain name.
*
*
* @param basePath
* The base path name that callers of the API must provide as part of the URL after the domain name. This
* value must be unique for all of the mappings across a single API. Leave this blank if you do not want
* callers to specify a base path name after the domain name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder basePath(String basePath);
/**
*
* The string identifier of the associated RestApi.
*
*
* @param restApiId
* The string identifier of the associated RestApi.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder restApiId(String restApiId);
/**
*
* The name of the API's stage that you want to use for this mapping. Leave this blank if you do not want
* callers to explicitly specify the stage name after any base path name.
*
*
* @param stage
* The name of the API's stage that you want to use for this mapping. Leave this blank if you do not want
* callers to explicitly specify the stage name after any base path name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stage(String stage);
@Override
Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig);
}
static final class BuilderImpl extends APIGatewayRequest.BuilderImpl implements Builder {
private String domainName;
private String basePath;
private String restApiId;
private String stage;
private BuilderImpl() {
}
private BuilderImpl(CreateBasePathMappingRequest model) {
domainName(model.domainName);
basePath(model.basePath);
restApiId(model.restApiId);
stage(model.stage);
}
public final String getDomainName() {
return domainName;
}
@Override
public final Builder domainName(String domainName) {
this.domainName = domainName;
return this;
}
public final void setDomainName(String domainName) {
this.domainName = domainName;
}
public final String getBasePath() {
return basePath;
}
@Override
public final Builder basePath(String basePath) {
this.basePath = basePath;
return this;
}
public final void setBasePath(String basePath) {
this.basePath = basePath;
}
public final String getRestApiId() {
return restApiId;
}
@Override
public final Builder restApiId(String restApiId) {
this.restApiId = restApiId;
return this;
}
public final void setRestApiId(String restApiId) {
this.restApiId = restApiId;
}
public final String getStage() {
return stage;
}
@Override
public final Builder stage(String stage) {
this.stage = stage;
return this;
}
public final void setStage(String stage) {
this.stage = stage;
}
@Override
public Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) {
super.requestOverrideConfig(awsRequestOverrideConfig);
return this;
}
@Override
public Builder requestOverrideConfig(Consumer builderConsumer) {
super.requestOverrideConfig(builderConsumer);
return this;
}
@Override
public CreateBasePathMappingRequest build() {
return new CreateBasePathMappingRequest(this);
}
}
}