software.amazon.awssdk.services.apigateway.model.GetDeploymentRequest Maven / Gradle / Ivy
Show all versions of apigateway Show documentation
/*
* 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.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 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.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;
/**
*
* Requests API Gateway to get information about a Deployment resource.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetDeploymentRequest extends ApiGatewayRequest implements
ToCopyableBuilder {
private static final SdkField REST_API_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("restApiId").getter(getter(GetDeploymentRequest::restApiId)).setter(setter(Builder::restApiId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("restapi_id").build()).build();
private static final SdkField DEPLOYMENT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("deploymentId").getter(getter(GetDeploymentRequest::deploymentId)).setter(setter(Builder::deploymentId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("deployment_id").build()).build();
private static final SdkField> EMBED_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("embed")
.getter(getter(GetDeploymentRequest::embed))
.setter(setter(Builder::embed))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("embed").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(REST_API_ID_FIELD,
DEPLOYMENT_ID_FIELD, EMBED_FIELD));
private final String restApiId;
private final String deploymentId;
private final List embed;
private GetDeploymentRequest(BuilderImpl builder) {
super(builder);
this.restApiId = builder.restApiId;
this.deploymentId = builder.deploymentId;
this.embed = builder.embed;
}
/**
*
* The string identifier of the associated RestApi.
*
*
* @return The string identifier of the associated RestApi.
*/
public final String restApiId() {
return restApiId;
}
/**
*
* The identifier of the Deployment resource to get information about.
*
*
* @return The identifier of the Deployment resource to get information about.
*/
public final String deploymentId() {
return deploymentId;
}
/**
* For responses, this returns true if the service returned a value for the Embed 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 hasEmbed() {
return embed != null && !(embed instanceof SdkAutoConstructList);
}
/**
*
* A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the
* response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in
* GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other
* platform-dependent libraries might use a different format for the list. Currently, this request supports only
* retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list
* containing only the "apisummary" string. For example,
* GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.
*
*
* 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 #hasEmbed} method.
*
*
* @return A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the
* response. In a REST API call, this embed parameter value is a list of comma-separated
* strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The
* SDK and other platform-dependent libraries might use a different format for the list. Currently, this
* request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be
* a single-valued list containing only the "apisummary" string. For example,
* GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.
*/
public final 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 final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(restApiId());
hashCode = 31 * hashCode + Objects.hashCode(deploymentId());
hashCode = 31 * hashCode + Objects.hashCode(hasEmbed() ? embed() : 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 GetDeploymentRequest)) {
return false;
}
GetDeploymentRequest other = (GetDeploymentRequest) obj;
return Objects.equals(restApiId(), other.restApiId()) && Objects.equals(deploymentId(), other.deploymentId())
&& hasEmbed() == other.hasEmbed() && Objects.equals(embed(), other.embed());
}
/**
* 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("GetDeploymentRequest").add("RestApiId", restApiId()).add("DeploymentId", deploymentId())
.add("Embed", hasEmbed() ? embed() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "restApiId":
return Optional.ofNullable(clazz.cast(restApiId()));
case "deploymentId":
return Optional.ofNullable(clazz.cast(deploymentId()));
case "embed":
return Optional.ofNullable(clazz.cast(embed()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetDeploymentRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ApiGatewayRequest.Builder, SdkPojo, 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 identifier of the Deployment resource to get information about.
*
*
* @param deploymentId
* The identifier of the Deployment resource to get information about.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deploymentId(String deploymentId);
/**
*
* A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the
* response. In a REST API call, this embed parameter value is a list of comma-separated strings,
* as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other
* platform-dependent libraries might use a different format for the list. Currently, this request supports only
* retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list
* containing only the "apisummary" string. For example,
* GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.
*
*
* @param embed
* A query parameter to retrieve the specified embedded resources of the returned Deployment resource in
* the response. In a REST API call, this embed parameter value is a list of comma-separated
* strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2.
* The SDK and other platform-dependent libraries might use a different format for the list. Currently,
* this request supports only retrieval of the embedded API summary this way. Hence, the parameter value
* must be a single-valued list containing only the "apisummary" string. For example,
* GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder embed(Collection embed);
/**
*
* A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the
* response. In a REST API call, this embed parameter value is a list of comma-separated strings,
* as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other
* platform-dependent libraries might use a different format for the list. Currently, this request supports only
* retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list
* containing only the "apisummary" string. For example,
* GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.
*
*
* @param embed
* A query parameter to retrieve the specified embedded resources of the returned Deployment resource in
* the response. In a REST API call, this embed parameter value is a list of comma-separated
* strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2.
* The SDK and other platform-dependent libraries might use a different format for the list. Currently,
* this request supports only retrieval of the embedded API summary this way. Hence, the parameter value
* must be a single-valued list containing only the "apisummary" string. For example,
* GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder embed(String... embed);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ApiGatewayRequest.BuilderImpl implements Builder {
private String restApiId;
private String deploymentId;
private List embed = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(GetDeploymentRequest model) {
super(model);
restApiId(model.restApiId);
deploymentId(model.deploymentId);
embed(model.embed);
}
public final String getRestApiId() {
return restApiId;
}
public final void setRestApiId(String restApiId) {
this.restApiId = restApiId;
}
@Override
public final Builder restApiId(String restApiId) {
this.restApiId = restApiId;
return this;
}
public final String getDeploymentId() {
return deploymentId;
}
public final void setDeploymentId(String deploymentId) {
this.deploymentId = deploymentId;
}
@Override
public final Builder deploymentId(String deploymentId) {
this.deploymentId = deploymentId;
return this;
}
public final Collection getEmbed() {
if (embed instanceof SdkAutoConstructList) {
return null;
}
return embed;
}
public final void setEmbed(Collection embed) {
this.embed = ListOfStringCopier.copy(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;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public GetDeploymentRequest build() {
return new GetDeploymentRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}