software.amazon.awssdk.services.networkfirewall.model.DescribeFirewallResponse Maven / Gradle / Ivy
/*
* 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.networkfirewall.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.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeFirewallResponse extends NetworkFirewallResponse implements
ToCopyableBuilder {
private static final SdkField UPDATE_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("UpdateToken").getter(getter(DescribeFirewallResponse::updateToken)).setter(setter(Builder::updateToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UpdateToken").build()).build();
private static final SdkField FIREWALL_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Firewall").getter(getter(DescribeFirewallResponse::firewall)).setter(setter(Builder::firewall))
.constructor(Firewall::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Firewall").build()).build();
private static final SdkField FIREWALL_STATUS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("FirewallStatus")
.getter(getter(DescribeFirewallResponse::firewallStatus)).setter(setter(Builder::firewallStatus))
.constructor(FirewallStatus::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FirewallStatus").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(UPDATE_TOKEN_FIELD,
FIREWALL_FIELD, FIREWALL_STATUS_FIELD));
private final String updateToken;
private final Firewall firewall;
private final FirewallStatus firewallStatus;
private DescribeFirewallResponse(BuilderImpl builder) {
super(builder);
this.updateToken = builder.updateToken;
this.firewall = builder.firewall;
this.firewallStatus = builder.firewallStatus;
}
/**
*
* An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that
* access the firewall. The token marks the state of the firewall resource at the time of the request.
*
*
* To make an unconditional change to the firewall, omit the token in your update request. Without the token,
* Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved
* it.
*
*
* To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the
* token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation
* fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current
* copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
*
*
* @return An optional token that you can use for optimistic locking. Network Firewall returns a token to your
* requests that access the firewall. The token marks the state of the firewall resource at the time of the
* request.
*
* To make an unconditional change to the firewall, omit the token in your update request. Without the
* token, Network Firewall performs your updates regardless of whether the firewall has changed since you
* last retrieved it.
*
*
* To make a conditional change to the firewall, provide the token in your update request. Network Firewall
* uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed,
* the operation fails with an InvalidTokenException. If this happens, retrieve the firewall
* again to get a current copy of it with a new token. Reapply your changes as needed, then try the
* operation again using the new token.
*/
public final String updateToken() {
return updateToken;
}
/**
*
* The configuration settings for the firewall. These settings include the firewall policy and the subnets in your
* VPC to use for the firewall endpoints.
*
*
* @return The configuration settings for the firewall. These settings include the firewall policy and the subnets
* in your VPC to use for the firewall endpoints.
*/
public final Firewall firewall() {
return firewall;
}
/**
*
* Detailed information about the current status of a Firewall. You can retrieve this for a firewall by
* calling DescribeFirewall and providing the firewall name and ARN.
*
*
* @return Detailed information about the current status of a Firewall. You can retrieve this for a firewall
* by calling DescribeFirewall and providing the firewall name and ARN.
*/
public final FirewallStatus firewallStatus() {
return firewallStatus;
}
@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(updateToken());
hashCode = 31 * hashCode + Objects.hashCode(firewall());
hashCode = 31 * hashCode + Objects.hashCode(firewallStatus());
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 DescribeFirewallResponse)) {
return false;
}
DescribeFirewallResponse other = (DescribeFirewallResponse) obj;
return Objects.equals(updateToken(), other.updateToken()) && Objects.equals(firewall(), other.firewall())
&& Objects.equals(firewallStatus(), other.firewallStatus());
}
/**
* 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("DescribeFirewallResponse").add("UpdateToken", updateToken()).add("Firewall", firewall())
.add("FirewallStatus", firewallStatus()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "UpdateToken":
return Optional.ofNullable(clazz.cast(updateToken()));
case "Firewall":
return Optional.ofNullable(clazz.cast(firewall()));
case "FirewallStatus":
return Optional.ofNullable(clazz.cast(firewallStatus()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeFirewallResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends NetworkFirewallResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests
* that access the firewall. The token marks the state of the firewall resource at the time of the request.
*
*
* To make an unconditional change to the firewall, omit the token in your update request. Without the token,
* Network Firewall performs your updates regardless of whether the firewall has changed since you last
* retrieved it.
*
*
* To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses
* the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the
* operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to
* get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using
* the new token.
*
*
* @param updateToken
* An optional token that you can use for optimistic locking. Network Firewall returns a token to your
* requests that access the firewall. The token marks the state of the firewall resource at the time of
* the request.
*
* To make an unconditional change to the firewall, omit the token in your update request. Without the
* token, Network Firewall performs your updates regardless of whether the firewall has changed since you
* last retrieved it.
*
*
* To make a conditional change to the firewall, provide the token in your update request. Network
* Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it
* has changed, the operation fails with an InvalidTokenException. If this happens, retrieve
* the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then
* try the operation again using the new token.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder updateToken(String updateToken);
/**
*
* The configuration settings for the firewall. These settings include the firewall policy and the subnets in
* your VPC to use for the firewall endpoints.
*
*
* @param firewall
* The configuration settings for the firewall. These settings include the firewall policy and the
* subnets in your VPC to use for the firewall endpoints.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder firewall(Firewall firewall);
/**
*
* The configuration settings for the firewall. These settings include the firewall policy and the subnets in
* your VPC to use for the firewall endpoints.
*
* This is a convenience method that creates an instance of the {@link Firewall.Builder} avoiding the need to
* create one manually via {@link Firewall#builder()}.
*
*
* When the {@link Consumer} completes, {@link Firewall.Builder#build()} is called immediately and its result is
* passed to {@link #firewall(Firewall)}.
*
* @param firewall
* a consumer that will call methods on {@link Firewall.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #firewall(Firewall)
*/
default Builder firewall(Consumer firewall) {
return firewall(Firewall.builder().applyMutation(firewall).build());
}
/**
*
* Detailed information about the current status of a Firewall. You can retrieve this for a firewall by
* calling DescribeFirewall and providing the firewall name and ARN.
*
*
* @param firewallStatus
* Detailed information about the current status of a Firewall. You can retrieve this for a
* firewall by calling DescribeFirewall and providing the firewall name and ARN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder firewallStatus(FirewallStatus firewallStatus);
/**
*
* Detailed information about the current status of a Firewall. You can retrieve this for a firewall by
* calling DescribeFirewall and providing the firewall name and ARN.
*
* This is a convenience method that creates an instance of the {@link FirewallStatus.Builder} avoiding the need
* to create one manually via {@link FirewallStatus#builder()}.
*
*
* When the {@link Consumer} completes, {@link FirewallStatus.Builder#build()} is called immediately and its
* result is passed to {@link #firewallStatus(FirewallStatus)}.
*
* @param firewallStatus
* a consumer that will call methods on {@link FirewallStatus.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #firewallStatus(FirewallStatus)
*/
default Builder firewallStatus(Consumer firewallStatus) {
return firewallStatus(FirewallStatus.builder().applyMutation(firewallStatus).build());
}
}
static final class BuilderImpl extends NetworkFirewallResponse.BuilderImpl implements Builder {
private String updateToken;
private Firewall firewall;
private FirewallStatus firewallStatus;
private BuilderImpl() {
}
private BuilderImpl(DescribeFirewallResponse model) {
super(model);
updateToken(model.updateToken);
firewall(model.firewall);
firewallStatus(model.firewallStatus);
}
public final String getUpdateToken() {
return updateToken;
}
public final void setUpdateToken(String updateToken) {
this.updateToken = updateToken;
}
@Override
public final Builder updateToken(String updateToken) {
this.updateToken = updateToken;
return this;
}
public final Firewall.Builder getFirewall() {
return firewall != null ? firewall.toBuilder() : null;
}
public final void setFirewall(Firewall.BuilderImpl firewall) {
this.firewall = firewall != null ? firewall.build() : null;
}
@Override
public final Builder firewall(Firewall firewall) {
this.firewall = firewall;
return this;
}
public final FirewallStatus.Builder getFirewallStatus() {
return firewallStatus != null ? firewallStatus.toBuilder() : null;
}
public final void setFirewallStatus(FirewallStatus.BuilderImpl firewallStatus) {
this.firewallStatus = firewallStatus != null ? firewallStatus.build() : null;
}
@Override
public final Builder firewallStatus(FirewallStatus firewallStatus) {
this.firewallStatus = firewallStatus;
return this;
}
@Override
public DescribeFirewallResponse build() {
return new DescribeFirewallResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}