software.amazon.awssdk.services.apigateway.model.Deployment 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.io.Serializable;
import java.time.Instant;
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.Function;
import software.amazon.awssdk.annotations.Generated;
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;
/**
*
* An immutable representation of a RestApi resource that can be called by users using Stages. A
* deployment must be associated with a Stage for it to be callable over the Internet.
*
* To create a deployment, call POST on the Deployments resource of a
* RestApi. To view, update, or delete a deployment, call GET, PATCH, or
* DELETE on the specified deployment resource (
* /restapis/{restapi_id}/deployments/{deployment_id}).
*/
@Generated("software.amazon.awssdk:codegen")
public final class Deployment implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("id")
.getter(getter(Deployment::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("id").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("description").getter(getter(Deployment::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField CREATED_DATE_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("createdDate").getter(getter(Deployment::createdDate)).setter(setter(Builder::createdDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("createdDate").build()).build();
private static final SdkField>> API_SUMMARY_FIELD = SdkField
.>> builder(MarshallingType.MAP)
.memberName("apiSummary")
.getter(getter(Deployment::apiSummary))
.setter(setter(Builder::apiSummary))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("apiSummary").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField.> builder(MarshallingType.MAP)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(MethodSnapshot::builder)
.traits(LocationTrait.builder()
.location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build())
.build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ID_FIELD, DESCRIPTION_FIELD,
CREATED_DATE_FIELD, API_SUMMARY_FIELD));
private static final long serialVersionUID = 1L;
private final String id;
private final String description;
private final Instant createdDate;
private final Map> apiSummary;
private Deployment(BuilderImpl builder) {
this.id = builder.id;
this.description = builder.description;
this.createdDate = builder.createdDate;
this.apiSummary = builder.apiSummary;
}
/**
*
* The identifier for the deployment resource.
*
*
* @return The identifier for the deployment resource.
*/
public final String id() {
return id;
}
/**
*
* The description for the deployment resource.
*
*
* @return The description for the deployment resource.
*/
public final String description() {
return description;
}
/**
*
* The date and time that the deployment resource was created.
*
*
* @return The date and time that the deployment resource was created.
*/
public final Instant createdDate() {
return createdDate;
}
/**
* Returns true if the ApiSummary property was specified by the sender (it may be empty), or false if the sender did
* not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasApiSummary() {
return apiSummary != null && !(apiSummary instanceof SdkAutoConstructMap);
}
/**
*
* A summary of the RestApi at the date and time that the deployment resource was created.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasApiSummary()} to see if a value was sent in this field.
*
*
* @return A summary of the RestApi at the date and time that the deployment resource was created.
*/
public final Map> apiSummary() {
return apiSummary;
}
@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 + Objects.hashCode(id());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(createdDate());
hashCode = 31 * hashCode + Objects.hashCode(hasApiSummary() ? apiSummary() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Deployment)) {
return false;
}
Deployment other = (Deployment) obj;
return Objects.equals(id(), other.id()) && Objects.equals(description(), other.description())
&& Objects.equals(createdDate(), other.createdDate()) && hasApiSummary() == other.hasApiSummary()
&& Objects.equals(apiSummary(), other.apiSummary());
}
/**
* 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("Deployment").add("Id", id()).add("Description", description()).add("CreatedDate", createdDate())
.add("ApiSummary", hasApiSummary() ? apiSummary() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "id":
return Optional.ofNullable(clazz.cast(id()));
case "description":
return Optional.ofNullable(clazz.cast(description()));
case "createdDate":
return Optional.ofNullable(clazz.cast(createdDate()));
case "apiSummary":
return Optional.ofNullable(clazz.cast(apiSummary()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Deployment) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The identifier for the deployment resource.
*
*
* @param id
* The identifier for the deployment resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* The description for the deployment resource.
*
*
* @param description
* The description for the deployment resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The date and time that the deployment resource was created.
*
*
* @param createdDate
* The date and time that the deployment resource was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder createdDate(Instant createdDate);
/**
*
* A summary of the RestApi at the date and time that the deployment resource was created.
*
*
* @param apiSummary
* A summary of the RestApi at the date and time that the deployment resource was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder apiSummary(Map> apiSummary);
}
static final class BuilderImpl implements Builder {
private String id;
private String description;
private Instant createdDate;
private Map> apiSummary = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(Deployment model) {
id(model.id);
description(model.description);
createdDate(model.createdDate);
apiSummary(model.apiSummary);
}
public final String getId() {
return id;
}
@Override
public final Builder id(String id) {
this.id = id;
return this;
}
public final void setId(String id) {
this.id = id;
}
public final String getDescription() {
return description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final void setDescription(String description) {
this.description = description;
}
public final Instant getCreatedDate() {
return createdDate;
}
@Override
public final Builder createdDate(Instant createdDate) {
this.createdDate = createdDate;
return this;
}
public final void setCreatedDate(Instant createdDate) {
this.createdDate = createdDate;
}
public final Map> getApiSummary() {
Map> result = PathToMapOfMethodSnapshotCopier
.copyToBuilder(this.apiSummary);
if (result instanceof SdkAutoConstructMap) {
return null;
}
return result;
}
@Override
public final Builder apiSummary(Map> apiSummary) {
this.apiSummary = PathToMapOfMethodSnapshotCopier.copy(apiSummary);
return this;
}
public final void setApiSummary(Map> apiSummary) {
this.apiSummary = PathToMapOfMethodSnapshotCopier.copyFromBuilder(apiSummary);
}
@Override
public Deployment build() {
return new Deployment(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}