software.amazon.awssdk.services.appconfig.model.GetEnvironmentResponse Maven / Gradle / Ivy
Show all versions of appconfig 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.appconfig.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 java.util.stream.Collectors;
import java.util.stream.Stream;
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.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetEnvironmentResponse extends AppConfigResponse implements
ToCopyableBuilder {
private static final SdkField APPLICATION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ApplicationId").getter(getter(GetEnvironmentResponse::applicationId))
.setter(setter(Builder::applicationId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ApplicationId").build()).build();
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Id")
.getter(getter(GetEnvironmentResponse::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Id").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(GetEnvironmentResponse::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(GetEnvironmentResponse::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("State")
.getter(getter(GetEnvironmentResponse::stateAsString)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("State").build()).build();
private static final SdkField> MONITORS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Monitors")
.getter(getter(GetEnvironmentResponse::monitors))
.setter(setter(Builder::monitors))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Monitors").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Monitor::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(APPLICATION_ID_FIELD,
ID_FIELD, NAME_FIELD, DESCRIPTION_FIELD, STATE_FIELD, MONITORS_FIELD));
private final String applicationId;
private final String id;
private final String name;
private final String description;
private final String state;
private final List monitors;
private GetEnvironmentResponse(BuilderImpl builder) {
super(builder);
this.applicationId = builder.applicationId;
this.id = builder.id;
this.name = builder.name;
this.description = builder.description;
this.state = builder.state;
this.monitors = builder.monitors;
}
/**
*
* The application ID.
*
*
* @return The application ID.
*/
public final String applicationId() {
return applicationId;
}
/**
*
* The environment ID.
*
*
* @return The environment ID.
*/
public final String id() {
return id;
}
/**
*
* The name of the environment.
*
*
* @return The name of the environment.
*/
public final String name() {
return name;
}
/**
*
* The description of the environment.
*
*
* @return The description of the environment.
*/
public final String description() {
return description;
}
/**
*
* The state of the environment. An environment can be in one of the following states:
* READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link EnvironmentState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The state of the environment. An environment can be in one of the following states:
* READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or
* ROLLED_BACK
* @see EnvironmentState
*/
public final EnvironmentState state() {
return EnvironmentState.fromValue(state);
}
/**
*
* The state of the environment. An environment can be in one of the following states:
* READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link EnvironmentState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The state of the environment. An environment can be in one of the following states:
* READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or
* ROLLED_BACK
* @see EnvironmentState
*/
public final String stateAsString() {
return state;
}
/**
* For responses, this returns true if the service returned a value for the Monitors 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 hasMonitors() {
return monitors != null && !(monitors instanceof SdkAutoConstructList);
}
/**
*
* Amazon CloudWatch alarms monitored during the deployment.
*
*
* 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 #hasMonitors} method.
*
*
* @return Amazon CloudWatch alarms monitored during the deployment.
*/
public final List monitors() {
return monitors;
}
@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(applicationId());
hashCode = 31 * hashCode + Objects.hashCode(id());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(stateAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasMonitors() ? monitors() : 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 GetEnvironmentResponse)) {
return false;
}
GetEnvironmentResponse other = (GetEnvironmentResponse) obj;
return Objects.equals(applicationId(), other.applicationId()) && Objects.equals(id(), other.id())
&& Objects.equals(name(), other.name()) && Objects.equals(description(), other.description())
&& Objects.equals(stateAsString(), other.stateAsString()) && hasMonitors() == other.hasMonitors()
&& Objects.equals(monitors(), other.monitors());
}
/**
* 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("GetEnvironmentResponse").add("ApplicationId", applicationId()).add("Id", id())
.add("Name", name()).add("Description", description()).add("State", stateAsString())
.add("Monitors", hasMonitors() ? monitors() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ApplicationId":
return Optional.ofNullable(clazz.cast(applicationId()));
case "Id":
return Optional.ofNullable(clazz.cast(id()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "State":
return Optional.ofNullable(clazz.cast(stateAsString()));
case "Monitors":
return Optional.ofNullable(clazz.cast(monitors()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetEnvironmentResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends AppConfigResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The application ID.
*
*
* @param applicationId
* The application ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder applicationId(String applicationId);
/**
*
* The environment ID.
*
*
* @param id
* The environment ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* The name of the environment.
*
*
* @param name
* The name of the environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The description of the environment.
*
*
* @param description
* The description of the environment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The state of the environment. An environment can be in one of the following states:
* READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or
* ROLLED_BACK
*
*
* @param state
* The state of the environment. An environment can be in one of the following states:
* READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or
* ROLLED_BACK
* @see EnvironmentState
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnvironmentState
*/
Builder state(String state);
/**
*
* The state of the environment. An environment can be in one of the following states:
* READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or
* ROLLED_BACK
*
*
* @param state
* The state of the environment. An environment can be in one of the following states:
* READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or
* ROLLED_BACK
* @see EnvironmentState
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnvironmentState
*/
Builder state(EnvironmentState state);
/**
*
* Amazon CloudWatch alarms monitored during the deployment.
*
*
* @param monitors
* Amazon CloudWatch alarms monitored during the deployment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder monitors(Collection monitors);
/**
*
* Amazon CloudWatch alarms monitored during the deployment.
*
*
* @param monitors
* Amazon CloudWatch alarms monitored during the deployment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder monitors(Monitor... monitors);
/**
*
* Amazon CloudWatch alarms monitored during the deployment.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.appconfig.model.Monitor.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.appconfig.model.Monitor#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.appconfig.model.Monitor.Builder#build()} is called immediately and its
* result is passed to {@link #monitors(List)}.
*
* @param monitors
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.appconfig.model.Monitor.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #monitors(java.util.Collection)
*/
Builder monitors(Consumer... monitors);
}
static final class BuilderImpl extends AppConfigResponse.BuilderImpl implements Builder {
private String applicationId;
private String id;
private String name;
private String description;
private String state;
private List monitors = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(GetEnvironmentResponse model) {
super(model);
applicationId(model.applicationId);
id(model.id);
name(model.name);
description(model.description);
state(model.state);
monitors(model.monitors);
}
public final String getApplicationId() {
return applicationId;
}
public final void setApplicationId(String applicationId) {
this.applicationId = applicationId;
}
@Override
public final Builder applicationId(String applicationId) {
this.applicationId = applicationId;
return this;
}
public final String getId() {
return id;
}
public final void setId(String id) {
this.id = id;
}
@Override
public final Builder id(String id) {
this.id = id;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final String getState() {
return state;
}
public final void setState(String state) {
this.state = state;
}
@Override
public final Builder state(String state) {
this.state = state;
return this;
}
@Override
public final Builder state(EnvironmentState state) {
this.state(state == null ? null : state.toString());
return this;
}
public final List getMonitors() {
List result = MonitorListCopier.copyToBuilder(this.monitors);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setMonitors(Collection monitors) {
this.monitors = MonitorListCopier.copyFromBuilder(monitors);
}
@Override
public final Builder monitors(Collection monitors) {
this.monitors = MonitorListCopier.copy(monitors);
return this;
}
@Override
@SafeVarargs
public final Builder monitors(Monitor... monitors) {
monitors(Arrays.asList(monitors));
return this;
}
@Override
@SafeVarargs
public final Builder monitors(Consumer... monitors) {
monitors(Stream.of(monitors).map(c -> Monitor.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public GetEnvironmentResponse build() {
return new GetEnvironmentResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}