software.amazon.awssdk.services.apigateway.model.GetGatewayResponsesRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of apigateway Show documentation
Show all versions of apigateway 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 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.Arrays;
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 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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any
* definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses
* collection for the supported response types.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetGatewayResponsesRequest extends ApiGatewayRequest implements
ToCopyableBuilder {
private static final SdkField REST_API_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(GetGatewayResponsesRequest::restApiId)).setter(setter(Builder::restApiId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("restapi_id").build()).build();
private static final SdkField POSITION_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(GetGatewayResponsesRequest::position)).setter(setter(Builder::position))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("position").build()).build();
private static final SdkField LIMIT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.getter(getter(GetGatewayResponsesRequest::limit)).setter(setter(Builder::limit))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("limit").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(REST_API_ID_FIELD,
POSITION_FIELD, LIMIT_FIELD));
private final String restApiId;
private final String position;
private final Integer limit;
private GetGatewayResponsesRequest(BuilderImpl builder) {
super(builder);
this.restApiId = builder.restApiId;
this.position = builder.position;
this.limit = builder.limit;
}
/**
*
* [Required] The string identifier of the associated RestApi.
*
*
* @return [Required] The string identifier of the associated RestApi.
*/
public String restApiId() {
return restApiId;
}
/**
*
* The current pagination position in the paged result set. The GatewayResponse collection does not support
* pagination and the position does not apply here.
*
*
* @return The current pagination position in the paged result set. The GatewayResponse collection does not
* support pagination and the position does not apply here.
*/
public String position() {
return position;
}
/**
*
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The
* GatewayResponses collection does not support pagination and the limit does not apply here.
*
*
* @return The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
* The GatewayResponses collection does not support pagination and the limit does not apply here.
*/
public Integer limit() {
return limit;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(restApiId());
hashCode = 31 * hashCode + Objects.hashCode(position());
hashCode = 31 * hashCode + Objects.hashCode(limit());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GetGatewayResponsesRequest)) {
return false;
}
GetGatewayResponsesRequest other = (GetGatewayResponsesRequest) obj;
return Objects.equals(restApiId(), other.restApiId()) && Objects.equals(position(), other.position())
&& Objects.equals(limit(), other.limit());
}
/**
* 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 String toString() {
return ToString.builder("GetGatewayResponsesRequest").add("RestApiId", restApiId()).add("Position", position())
.add("Limit", limit()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "restApiId":
return Optional.ofNullable(clazz.cast(restApiId()));
case "position":
return Optional.ofNullable(clazz.cast(position()));
case "limit":
return Optional.ofNullable(clazz.cast(limit()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetGatewayResponsesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ApiGatewayRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* [Required] The string identifier of the associated RestApi.
*
*
* @param restApiId
* [Required] 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 current pagination position in the paged result set. The GatewayResponse collection does not
* support pagination and the position does not apply here.
*
*
* @param position
* The current pagination position in the paged result set. The GatewayResponse collection does
* not support pagination and the position does not apply here.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder position(String position);
/**
*
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The
* GatewayResponses collection does not support pagination and the limit does not apply here.
*
*
* @param limit
* The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
* The GatewayResponses collection does not support pagination and the limit does not apply here.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder limit(Integer limit);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ApiGatewayRequest.BuilderImpl implements Builder {
private String restApiId;
private String position;
private Integer limit;
private BuilderImpl() {
}
private BuilderImpl(GetGatewayResponsesRequest model) {
super(model);
restApiId(model.restApiId);
position(model.position);
limit(model.limit);
}
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 getPosition() {
return position;
}
@Override
public final Builder position(String position) {
this.position = position;
return this;
}
public final void setPosition(String position) {
this.position = position;
}
public final Integer getLimit() {
return limit;
}
@Override
public final Builder limit(Integer limit) {
this.limit = limit;
return this;
}
public final void setLimit(Integer limit) {
this.limit = limit;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public GetGatewayResponsesRequest build() {
return new GetGatewayResponsesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}