software.amazon.awssdk.services.apigateway.model.GetResourcesRequest Maven / Gradle / Ivy
Show all versions of api-gateway Show documentation
/*
* 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.Arrays;
import java.util.Collection;
import java.util.List;
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;
/**
*
* Request to list information about a collection of resources.
*
*/
@Generated("software.amazon.awssdk:codegen")
public class GetResourcesRequest extends APIGatewayRequest implements
ToCopyableBuilder {
private final String restApiId;
private final String position;
private final Integer limit;
private final List embed;
private GetResourcesRequest(BuilderImpl builder) {
super(builder);
this.restApiId = builder.restApiId;
this.position = builder.position;
this.limit = builder.limit;
this.embed = builder.embed;
}
/**
*
* The string identifier of the associated RestApi.
*
*
* @return The string identifier of the associated RestApi.
*/
public String restApiId() {
return restApiId;
}
/**
*
* The current pagination position in the paged result set.
*
*
* @return The current pagination position in the paged result set.
*/
public String position() {
return position;
}
/**
*
* The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.
*
*
* @return The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.
*/
public Integer limit() {
return limit;
}
/**
*
* A query parameter used to retrieve the specified resources embedded in the returned Resources resource in
* the response. This embed parameter value is a list of comma-separated strings. Currently, the
* request supports only retrieval of the embedded Method resources this way. The query parameter value must
* be a single-valued list and contain the "methods" string. For example,
* GET /restapis/{restapi_id}/resources?embed=methods.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return A query parameter used to retrieve the specified resources embedded in the returned Resources
* resource in the response. This embed parameter value is a list of comma-separated strings.
* Currently, the request supports only retrieval of the embedded Method resources this way. The
* query parameter value must be a single-valued list and contain the "methods" string. For
* example, GET /restapis/{restapi_id}/resources?embed=methods.
*/
public List embed() {
return embed;
}
@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(restApiId());
hashCode = 31 * hashCode + Objects.hashCode(position());
hashCode = 31 * hashCode + Objects.hashCode(limit());
hashCode = 31 * hashCode + Objects.hashCode(embed());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GetResourcesRequest)) {
return false;
}
GetResourcesRequest other = (GetResourcesRequest) obj;
return Objects.equals(restApiId(), other.restApiId()) && Objects.equals(position(), other.position())
&& Objects.equals(limit(), other.limit()) && Objects.equals(embed(), other.embed());
}
@Override
public String toString() {
return ToString.builder("GetResourcesRequest").add("RestApiId", restApiId()).add("Position", position())
.add("Limit", limit()).add("Embed", embed()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "restApiId":
return Optional.of(clazz.cast(restApiId()));
case "position":
return Optional.of(clazz.cast(position()));
case "limit":
return Optional.of(clazz.cast(limit()));
case "embed":
return Optional.of(clazz.cast(embed()));
default:
return Optional.empty();
}
}
public interface Builder extends APIGatewayRequest.Builder, CopyableBuilder {
/**
*
* 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 current pagination position in the paged result set.
*
*
* @param position
* The current pagination position in the paged result set.
* @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 value is 25 by default and could be between 1 - 500.
*
*
* @param limit
* The maximum number of returned results per page. The value is 25 by default and could be between 1 -
* 500.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder limit(Integer limit);
/**
*
* A query parameter used to retrieve the specified resources embedded in the returned Resources resource
* in the response. This embed parameter value is a list of comma-separated strings. Currently, the
* request supports only retrieval of the embedded Method resources this way. The query parameter value
* must be a single-valued list and contain the "methods" string. For example,
* GET /restapis/{restapi_id}/resources?embed=methods.
*
*
* @param embed
* A query parameter used to retrieve the specified resources embedded in the returned Resources
* resource in the response. This embed parameter value is a list of comma-separated
* strings. Currently, the request supports only retrieval of the embedded Method resources this
* way. The query parameter value must be a single-valued list and contain the "methods"
* string. For example, GET /restapis/{restapi_id}/resources?embed=methods.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder embed(Collection embed);
/**
*
* A query parameter used to retrieve the specified resources embedded in the returned Resources resource
* in the response. This embed parameter value is a list of comma-separated strings. Currently, the
* request supports only retrieval of the embedded Method resources this way. The query parameter value
* must be a single-valued list and contain the "methods" string. For example,
* GET /restapis/{restapi_id}/resources?embed=methods.
*
*
* @param embed
* A query parameter used to retrieve the specified resources embedded in the returned Resources
* resource in the response. This embed parameter value is a list of comma-separated
* strings. Currently, the request supports only retrieval of the embedded Method resources this
* way. The query parameter value must be a single-valued list and contain the "methods"
* string. For example, GET /restapis/{restapi_id}/resources?embed=methods.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder embed(String... embed);
@Override
Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig);
}
static final class BuilderImpl extends APIGatewayRequest.BuilderImpl implements Builder {
private String restApiId;
private String position;
private Integer limit;
private List embed;
private BuilderImpl() {
}
private BuilderImpl(GetResourcesRequest model) {
restApiId(model.restApiId);
position(model.position);
limit(model.limit);
embed(model.embed);
}
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;
}
public final Collection getEmbed() {
return embed;
}
@Override
public final Builder embed(Collection embed) {
this.embed = ListOfStringCopier.copy(embed);
return this;
}
@Override
@SafeVarargs
public final Builder embed(String... embed) {
embed(Arrays.asList(embed));
return this;
}
public final void setEmbed(Collection embed) {
this.embed = ListOfStringCopier.copy(embed);
}
@Override
public Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) {
super.requestOverrideConfig(awsRequestOverrideConfig);
return this;
}
@Override
public Builder requestOverrideConfig(Consumer builderConsumer) {
super.requestOverrideConfig(builderConsumer);
return this;
}
@Override
public GetResourcesRequest build() {
return new GetResourcesRequest(this);
}
}
}