software.amazon.awssdk.services.iot.model.RegisterCaCertificateRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of iot Show documentation
Show all versions of iot Show documentation
The AWS Java SDK for AWS Iot Service module holds the client classes that are used for communicating
with AWS IoT Service
/*
* 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.iot.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.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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The input to the RegisterCACertificate operation.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class RegisterCaCertificateRequest extends IotRequest implements
ToCopyableBuilder {
private static final SdkField CA_CERTIFICATE_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(RegisterCaCertificateRequest::caCertificate)).setter(setter(Builder::caCertificate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("caCertificate").build()).build();
private static final SdkField VERIFICATION_CERTIFICATE_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(RegisterCaCertificateRequest::verificationCertificate))
.setter(setter(Builder::verificationCertificate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("verificationCertificate").build())
.build();
private static final SdkField SET_AS_ACTIVE_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.getter(getter(RegisterCaCertificateRequest::setAsActive)).setter(setter(Builder::setAsActive))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("setAsActive").build()).build();
private static final SdkField ALLOW_AUTO_REGISTRATION_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.getter(getter(RegisterCaCertificateRequest::allowAutoRegistration)).setter(setter(Builder::allowAutoRegistration))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("allowAutoRegistration").build())
.build();
private static final SdkField REGISTRATION_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.getter(getter(RegisterCaCertificateRequest::registrationConfig)).setter(setter(Builder::registrationConfig))
.constructor(RegistrationConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("registrationConfig").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CA_CERTIFICATE_FIELD,
VERIFICATION_CERTIFICATE_FIELD, SET_AS_ACTIVE_FIELD, ALLOW_AUTO_REGISTRATION_FIELD, REGISTRATION_CONFIG_FIELD));
private final String caCertificate;
private final String verificationCertificate;
private final Boolean setAsActive;
private final Boolean allowAutoRegistration;
private final RegistrationConfig registrationConfig;
private RegisterCaCertificateRequest(BuilderImpl builder) {
super(builder);
this.caCertificate = builder.caCertificate;
this.verificationCertificate = builder.verificationCertificate;
this.setAsActive = builder.setAsActive;
this.allowAutoRegistration = builder.allowAutoRegistration;
this.registrationConfig = builder.registrationConfig;
}
/**
*
* The CA certificate.
*
*
* @return The CA certificate.
*/
public String caCertificate() {
return caCertificate;
}
/**
*
* The private key verification certificate.
*
*
* @return The private key verification certificate.
*/
public String verificationCertificate() {
return verificationCertificate;
}
/**
*
* A boolean value that specifies if the CA certificate is set to active.
*
*
* @return A boolean value that specifies if the CA certificate is set to active.
*/
public Boolean setAsActive() {
return setAsActive;
}
/**
*
* Allows this CA certificate to be used for auto registration of device certificates.
*
*
* @return Allows this CA certificate to be used for auto registration of device certificates.
*/
public Boolean allowAutoRegistration() {
return allowAutoRegistration;
}
/**
*
* Information about the registration configuration.
*
*
* @return Information about the registration configuration.
*/
public RegistrationConfig registrationConfig() {
return registrationConfig;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(caCertificate());
hashCode = 31 * hashCode + Objects.hashCode(verificationCertificate());
hashCode = 31 * hashCode + Objects.hashCode(setAsActive());
hashCode = 31 * hashCode + Objects.hashCode(allowAutoRegistration());
hashCode = 31 * hashCode + Objects.hashCode(registrationConfig());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof RegisterCaCertificateRequest)) {
return false;
}
RegisterCaCertificateRequest other = (RegisterCaCertificateRequest) obj;
return Objects.equals(caCertificate(), other.caCertificate())
&& Objects.equals(verificationCertificate(), other.verificationCertificate())
&& Objects.equals(setAsActive(), other.setAsActive())
&& Objects.equals(allowAutoRegistration(), other.allowAutoRegistration())
&& Objects.equals(registrationConfig(), other.registrationConfig());
}
/**
* 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 String toString() {
return ToString.builder("RegisterCaCertificateRequest").add("CaCertificate", caCertificate())
.add("VerificationCertificate", verificationCertificate()).add("SetAsActive", setAsActive())
.add("AllowAutoRegistration", allowAutoRegistration()).add("RegistrationConfig", registrationConfig()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "caCertificate":
return Optional.ofNullable(clazz.cast(caCertificate()));
case "verificationCertificate":
return Optional.ofNullable(clazz.cast(verificationCertificate()));
case "setAsActive":
return Optional.ofNullable(clazz.cast(setAsActive()));
case "allowAutoRegistration":
return Optional.ofNullable(clazz.cast(allowAutoRegistration()));
case "registrationConfig":
return Optional.ofNullable(clazz.cast(registrationConfig()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((RegisterCaCertificateRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IotRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The CA certificate.
*
*
* @param caCertificate
* The CA certificate.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder caCertificate(String caCertificate);
/**
*
* The private key verification certificate.
*
*
* @param verificationCertificate
* The private key verification certificate.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder verificationCertificate(String verificationCertificate);
/**
*
* A boolean value that specifies if the CA certificate is set to active.
*
*
* @param setAsActive
* A boolean value that specifies if the CA certificate is set to active.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder setAsActive(Boolean setAsActive);
/**
*
* Allows this CA certificate to be used for auto registration of device certificates.
*
*
* @param allowAutoRegistration
* Allows this CA certificate to be used for auto registration of device certificates.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allowAutoRegistration(Boolean allowAutoRegistration);
/**
*
* Information about the registration configuration.
*
*
* @param registrationConfig
* Information about the registration configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder registrationConfig(RegistrationConfig registrationConfig);
/**
*
* Information about the registration configuration.
*
* This is a convenience that creates an instance of the {@link RegistrationConfig.Builder} avoiding the need to
* create one manually via {@link RegistrationConfig#builder()}.
*
* When the {@link Consumer} completes, {@link RegistrationConfig.Builder#build()} is called immediately and its
* result is passed to {@link #registrationConfig(RegistrationConfig)}.
*
* @param registrationConfig
* a consumer that will call methods on {@link RegistrationConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #registrationConfig(RegistrationConfig)
*/
default Builder registrationConfig(Consumer registrationConfig) {
return registrationConfig(RegistrationConfig.builder().applyMutation(registrationConfig).build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IotRequest.BuilderImpl implements Builder {
private String caCertificate;
private String verificationCertificate;
private Boolean setAsActive;
private Boolean allowAutoRegistration;
private RegistrationConfig registrationConfig;
private BuilderImpl() {
}
private BuilderImpl(RegisterCaCertificateRequest model) {
super(model);
caCertificate(model.caCertificate);
verificationCertificate(model.verificationCertificate);
setAsActive(model.setAsActive);
allowAutoRegistration(model.allowAutoRegistration);
registrationConfig(model.registrationConfig);
}
public final String getCaCertificate() {
return caCertificate;
}
@Override
public final Builder caCertificate(String caCertificate) {
this.caCertificate = caCertificate;
return this;
}
public final void setCaCertificate(String caCertificate) {
this.caCertificate = caCertificate;
}
public final String getVerificationCertificate() {
return verificationCertificate;
}
@Override
public final Builder verificationCertificate(String verificationCertificate) {
this.verificationCertificate = verificationCertificate;
return this;
}
public final void setVerificationCertificate(String verificationCertificate) {
this.verificationCertificate = verificationCertificate;
}
public final Boolean getSetAsActive() {
return setAsActive;
}
@Override
public final Builder setAsActive(Boolean setAsActive) {
this.setAsActive = setAsActive;
return this;
}
public final void setSetAsActive(Boolean setAsActive) {
this.setAsActive = setAsActive;
}
public final Boolean getAllowAutoRegistration() {
return allowAutoRegistration;
}
@Override
public final Builder allowAutoRegistration(Boolean allowAutoRegistration) {
this.allowAutoRegistration = allowAutoRegistration;
return this;
}
public final void setAllowAutoRegistration(Boolean allowAutoRegistration) {
this.allowAutoRegistration = allowAutoRegistration;
}
public final RegistrationConfig.Builder getRegistrationConfig() {
return registrationConfig != null ? registrationConfig.toBuilder() : null;
}
@Override
public final Builder registrationConfig(RegistrationConfig registrationConfig) {
this.registrationConfig = registrationConfig;
return this;
}
public final void setRegistrationConfig(RegistrationConfig.BuilderImpl registrationConfig) {
this.registrationConfig = registrationConfig != null ? registrationConfig.build() : null;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public RegisterCaCertificateRequest build() {
return new RegisterCaCertificateRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}