software.amazon.awssdk.services.fms.model.AdminAccountSummary 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.fms.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains high level information about the Firewall Manager administrator account.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AdminAccountSummary implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ADMIN_ACCOUNT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AdminAccount").getter(getter(AdminAccountSummary::adminAccount)).setter(setter(Builder::adminAccount))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AdminAccount").build()).build();
private static final SdkField DEFAULT_ADMIN_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("DefaultAdmin").getter(getter(AdminAccountSummary::defaultAdmin)).setter(setter(Builder::defaultAdmin))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DefaultAdmin").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(AdminAccountSummary::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ADMIN_ACCOUNT_FIELD,
DEFAULT_ADMIN_FIELD, STATUS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("AdminAccount", ADMIN_ACCOUNT_FIELD);
put("DefaultAdmin", DEFAULT_ADMIN_FIELD);
put("Status", STATUS_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final String adminAccount;
private final Boolean defaultAdmin;
private final String status;
private AdminAccountSummary(BuilderImpl builder) {
this.adminAccount = builder.adminAccount;
this.defaultAdmin = builder.defaultAdmin;
this.status = builder.status;
}
/**
*
* The Amazon Web Services account ID of the Firewall Manager administrator's account.
*
*
* @return The Amazon Web Services account ID of the Firewall Manager administrator's account.
*/
public final String adminAccount() {
return adminAccount;
}
/**
*
* A boolean value that indicates if the administrator is the default administrator. If true, then this is the
* default administrator account. The default administrator can manage third-party firewalls and has full
* administrative scope. There is only one default administrator account per organization. For information about
* Firewall Manager default administrator accounts, see Managing Firewall Manager
* administrators in the Firewall Manager Developer Guide.
*
*
* @return A boolean value that indicates if the administrator is the default administrator. If true, then this is
* the default administrator account. The default administrator can manage third-party firewalls and has
* full administrative scope. There is only one default administrator account per organization. For
* information about Firewall Manager default administrator accounts, see Managing Firewall
* Manager administrators in the Firewall Manager Developer Guide.
*/
public final Boolean defaultAdmin() {
return defaultAdmin;
}
/**
*
* The current status of the request to onboard a member account as an Firewall Manager administrator.
*
*
* -
*
* ONBOARDING - The account is onboarding to Firewall Manager as an administrator.
*
*
* -
*
* ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an
* administrator, and can perform actions on the resources defined in their AdminScope.
*
*
* -
*
* OFFBOARDING - The account is being removed as an Firewall Manager administrator.
*
*
* -
*
* OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link OrganizationStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The current status of the request to onboard a member account as an Firewall Manager administrator.
*
* -
*
* ONBOARDING - The account is onboarding to Firewall Manager as an administrator.
*
*
* -
*
* ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an
* administrator, and can perform actions on the resources defined in their AdminScope.
*
*
* -
*
* OFFBOARDING - The account is being removed as an Firewall Manager administrator.
*
*
* -
*
* OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.
*
*
* @see OrganizationStatus
*/
public final OrganizationStatus status() {
return OrganizationStatus.fromValue(status);
}
/**
*
* The current status of the request to onboard a member account as an Firewall Manager administrator.
*
*
* -
*
* ONBOARDING - The account is onboarding to Firewall Manager as an administrator.
*
*
* -
*
* ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an
* administrator, and can perform actions on the resources defined in their AdminScope.
*
*
* -
*
* OFFBOARDING - The account is being removed as an Firewall Manager administrator.
*
*
* -
*
* OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link OrganizationStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The current status of the request to onboard a member account as an Firewall Manager administrator.
*
* -
*
* ONBOARDING - The account is onboarding to Firewall Manager as an administrator.
*
*
* -
*
* ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an
* administrator, and can perform actions on the resources defined in their AdminScope.
*
*
* -
*
* OFFBOARDING - The account is being removed as an Firewall Manager administrator.
*
*
* -
*
* OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.
*
*
* @see OrganizationStatus
*/
public final String statusAsString() {
return status;
}
@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(adminAccount());
hashCode = 31 * hashCode + Objects.hashCode(defaultAdmin());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
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 AdminAccountSummary)) {
return false;
}
AdminAccountSummary other = (AdminAccountSummary) obj;
return Objects.equals(adminAccount(), other.adminAccount()) && Objects.equals(defaultAdmin(), other.defaultAdmin())
&& Objects.equals(statusAsString(), other.statusAsString());
}
/**
* 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("AdminAccountSummary").add("AdminAccount", adminAccount()).add("DefaultAdmin", defaultAdmin())
.add("Status", statusAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AdminAccount":
return Optional.ofNullable(clazz.cast(adminAccount()));
case "DefaultAdmin":
return Optional.ofNullable(clazz.cast(defaultAdmin()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((AdminAccountSummary) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The Amazon Web Services account ID of the Firewall Manager administrator's account.
*
*
* @param adminAccount
* The Amazon Web Services account ID of the Firewall Manager administrator's account.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder adminAccount(String adminAccount);
/**
*
* A boolean value that indicates if the administrator is the default administrator. If true, then this is the
* default administrator account. The default administrator can manage third-party firewalls and has full
* administrative scope. There is only one default administrator account per organization. For information about
* Firewall Manager default administrator accounts, see Managing Firewall
* Manager administrators in the Firewall Manager Developer Guide.
*
*
* @param defaultAdmin
* A boolean value that indicates if the administrator is the default administrator. If true, then this
* is the default administrator account. The default administrator can manage third-party firewalls and
* has full administrative scope. There is only one default administrator account per organization. For
* information about Firewall Manager default administrator accounts, see Managing Firewall
* Manager administrators in the Firewall Manager Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder defaultAdmin(Boolean defaultAdmin);
/**
*
* The current status of the request to onboard a member account as an Firewall Manager administrator.
*
*
* -
*
* ONBOARDING - The account is onboarding to Firewall Manager as an administrator.
*
*
* -
*
* ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an
* administrator, and can perform actions on the resources defined in their AdminScope.
*
*
* -
*
* OFFBOARDING - The account is being removed as an Firewall Manager administrator.
*
*
* -
*
* OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.
*
*
*
*
* @param status
* The current status of the request to onboard a member account as an Firewall Manager
* administrator.
*
* -
*
* ONBOARDING - The account is onboarding to Firewall Manager as an administrator.
*
*
* -
*
* ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an
* administrator, and can perform actions on the resources defined in their AdminScope.
*
*
* -
*
* OFFBOARDING - The account is being removed as an Firewall Manager administrator.
*
*
* -
*
* OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.
*
*
* @see OrganizationStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see OrganizationStatus
*/
Builder status(String status);
/**
*
* The current status of the request to onboard a member account as an Firewall Manager administrator.
*
*
* -
*
* ONBOARDING - The account is onboarding to Firewall Manager as an administrator.
*
*
* -
*
* ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an
* administrator, and can perform actions on the resources defined in their AdminScope.
*
*
* -
*
* OFFBOARDING - The account is being removed as an Firewall Manager administrator.
*
*
* -
*
* OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.
*
*
*
*
* @param status
* The current status of the request to onboard a member account as an Firewall Manager
* administrator.
*
* -
*
* ONBOARDING - The account is onboarding to Firewall Manager as an administrator.
*
*
* -
*
* ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an
* administrator, and can perform actions on the resources defined in their AdminScope.
*
*
* -
*
* OFFBOARDING - The account is being removed as an Firewall Manager administrator.
*
*
* -
*
* OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.
*
*
* @see OrganizationStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see OrganizationStatus
*/
Builder status(OrganizationStatus status);
}
static final class BuilderImpl implements Builder {
private String adminAccount;
private Boolean defaultAdmin;
private String status;
private BuilderImpl() {
}
private BuilderImpl(AdminAccountSummary model) {
adminAccount(model.adminAccount);
defaultAdmin(model.defaultAdmin);
status(model.status);
}
public final String getAdminAccount() {
return adminAccount;
}
public final void setAdminAccount(String adminAccount) {
this.adminAccount = adminAccount;
}
@Override
public final Builder adminAccount(String adminAccount) {
this.adminAccount = adminAccount;
return this;
}
public final Boolean getDefaultAdmin() {
return defaultAdmin;
}
public final void setDefaultAdmin(Boolean defaultAdmin) {
this.defaultAdmin = defaultAdmin;
}
@Override
public final Builder defaultAdmin(Boolean defaultAdmin) {
this.defaultAdmin = defaultAdmin;
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(OrganizationStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
@Override
public AdminAccountSummary build() {
return new AdminAccountSummary(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}