software.amazon.awssdk.services.iot.model.DescribeScheduledAuditResponse Maven / Gradle / Ivy
Show all versions of iot 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.iot.model;
import java.util.Arrays;
import java.util.Collection;
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.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 DescribeScheduledAuditResponse extends IotResponse implements
ToCopyableBuilder {
private static final SdkField FREQUENCY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("frequency").getter(getter(DescribeScheduledAuditResponse::frequencyAsString))
.setter(setter(Builder::frequency))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("frequency").build()).build();
private static final SdkField DAY_OF_MONTH_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("dayOfMonth").getter(getter(DescribeScheduledAuditResponse::dayOfMonth))
.setter(setter(Builder::dayOfMonth))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("dayOfMonth").build()).build();
private static final SdkField DAY_OF_WEEK_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("dayOfWeek").getter(getter(DescribeScheduledAuditResponse::dayOfWeekAsString))
.setter(setter(Builder::dayOfWeek))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("dayOfWeek").build()).build();
private static final SdkField> TARGET_CHECK_NAMES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("targetCheckNames")
.getter(getter(DescribeScheduledAuditResponse::targetCheckNames))
.setter(setter(Builder::targetCheckNames))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("targetCheckNames").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField SCHEDULED_AUDIT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("scheduledAuditName").getter(getter(DescribeScheduledAuditResponse::scheduledAuditName))
.setter(setter(Builder::scheduledAuditName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("scheduledAuditName").build())
.build();
private static final SdkField SCHEDULED_AUDIT_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("scheduledAuditArn").getter(getter(DescribeScheduledAuditResponse::scheduledAuditArn))
.setter(setter(Builder::scheduledAuditArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("scheduledAuditArn").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(FREQUENCY_FIELD,
DAY_OF_MONTH_FIELD, DAY_OF_WEEK_FIELD, TARGET_CHECK_NAMES_FIELD, SCHEDULED_AUDIT_NAME_FIELD,
SCHEDULED_AUDIT_ARN_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String frequency;
private final String dayOfMonth;
private final String dayOfWeek;
private final List targetCheckNames;
private final String scheduledAuditName;
private final String scheduledAuditArn;
private DescribeScheduledAuditResponse(BuilderImpl builder) {
super(builder);
this.frequency = builder.frequency;
this.dayOfMonth = builder.dayOfMonth;
this.dayOfWeek = builder.dayOfWeek;
this.targetCheckNames = builder.targetCheckNames;
this.scheduledAuditName = builder.scheduledAuditName;
this.scheduledAuditArn = builder.scheduledAuditArn;
}
/**
*
* How often the scheduled audit takes place, either one of DAILY, WEEKLY,
* BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #frequency} will
* return {@link AuditFrequency#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #frequencyAsString}.
*
*
* @return How often the scheduled audit takes place, either one of DAILY, WEEKLY,
* BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.
* @see AuditFrequency
*/
public final AuditFrequency frequency() {
return AuditFrequency.fromValue(frequency);
}
/**
*
* How often the scheduled audit takes place, either one of DAILY, WEEKLY,
* BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #frequency} will
* return {@link AuditFrequency#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #frequencyAsString}.
*
*
* @return How often the scheduled audit takes place, either one of DAILY, WEEKLY,
* BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.
* @see AuditFrequency
*/
public final String frequencyAsString() {
return frequency;
}
/**
*
* The day of the month on which the scheduled audit takes place. This is will be 1 through
* 31 or LAST. If days 29-31 are specified, and the month does
* not have that many days, the audit takes place on the LAST day of the month.
*
*
* @return The day of the month on which the scheduled audit takes place. This is will be 1 through
* 31 or LAST. If days 29-31 are specified, and the
* month does not have that many days, the audit takes place on the LAST day of the month.
*/
public final String dayOfMonth() {
return dayOfMonth;
}
/**
*
* The day of the week on which the scheduled audit takes place, either one of SUN, MON,
* TUE, WED, THU, FRI, or SAT.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #dayOfWeek} will
* return {@link DayOfWeek#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #dayOfWeekAsString}.
*
*
* @return The day of the week on which the scheduled audit takes place, either one of SUN,
* MON, TUE, WED, THU, FRI, or
* SAT.
* @see DayOfWeek
*/
public final DayOfWeek dayOfWeek() {
return DayOfWeek.fromValue(dayOfWeek);
}
/**
*
* The day of the week on which the scheduled audit takes place, either one of SUN, MON,
* TUE, WED, THU, FRI, or SAT.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #dayOfWeek} will
* return {@link DayOfWeek#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #dayOfWeekAsString}.
*
*
* @return The day of the week on which the scheduled audit takes place, either one of SUN,
* MON, TUE, WED, THU, FRI, or
* SAT.
* @see DayOfWeek
*/
public final String dayOfWeekAsString() {
return dayOfWeek;
}
/**
* For responses, this returns true if the service returned a value for the TargetCheckNames 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 hasTargetCheckNames() {
return targetCheckNames != null && !(targetCheckNames instanceof SdkAutoConstructList);
}
/**
*
* Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use
* DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or
* use UpdateAccountAuditConfiguration to select which checks are enabled.)
*
*
* 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 #hasTargetCheckNames} method.
*
*
* @return Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use
* DescribeAccountAuditConfiguration to see the list of all checks, including those that are
* enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
*/
public final List targetCheckNames() {
return targetCheckNames;
}
/**
*
* The name of the scheduled audit.
*
*
* @return The name of the scheduled audit.
*/
public final String scheduledAuditName() {
return scheduledAuditName;
}
/**
*
* The ARN of the scheduled audit.
*
*
* @return The ARN of the scheduled audit.
*/
public final String scheduledAuditArn() {
return scheduledAuditArn;
}
@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(frequencyAsString());
hashCode = 31 * hashCode + Objects.hashCode(dayOfMonth());
hashCode = 31 * hashCode + Objects.hashCode(dayOfWeekAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasTargetCheckNames() ? targetCheckNames() : null);
hashCode = 31 * hashCode + Objects.hashCode(scheduledAuditName());
hashCode = 31 * hashCode + Objects.hashCode(scheduledAuditArn());
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 DescribeScheduledAuditResponse)) {
return false;
}
DescribeScheduledAuditResponse other = (DescribeScheduledAuditResponse) obj;
return Objects.equals(frequencyAsString(), other.frequencyAsString()) && Objects.equals(dayOfMonth(), other.dayOfMonth())
&& Objects.equals(dayOfWeekAsString(), other.dayOfWeekAsString())
&& hasTargetCheckNames() == other.hasTargetCheckNames()
&& Objects.equals(targetCheckNames(), other.targetCheckNames())
&& Objects.equals(scheduledAuditName(), other.scheduledAuditName())
&& Objects.equals(scheduledAuditArn(), other.scheduledAuditArn());
}
/**
* 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("DescribeScheduledAuditResponse").add("Frequency", frequencyAsString())
.add("DayOfMonth", dayOfMonth()).add("DayOfWeek", dayOfWeekAsString())
.add("TargetCheckNames", hasTargetCheckNames() ? targetCheckNames() : null)
.add("ScheduledAuditName", scheduledAuditName()).add("ScheduledAuditArn", scheduledAuditArn()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "frequency":
return Optional.ofNullable(clazz.cast(frequencyAsString()));
case "dayOfMonth":
return Optional.ofNullable(clazz.cast(dayOfMonth()));
case "dayOfWeek":
return Optional.ofNullable(clazz.cast(dayOfWeekAsString()));
case "targetCheckNames":
return Optional.ofNullable(clazz.cast(targetCheckNames()));
case "scheduledAuditName":
return Optional.ofNullable(clazz.cast(scheduledAuditName()));
case "scheduledAuditArn":
return Optional.ofNullable(clazz.cast(scheduledAuditArn()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("frequency", FREQUENCY_FIELD);
map.put("dayOfMonth", DAY_OF_MONTH_FIELD);
map.put("dayOfWeek", DAY_OF_WEEK_FIELD);
map.put("targetCheckNames", TARGET_CHECK_NAMES_FIELD);
map.put("scheduledAuditName", SCHEDULED_AUDIT_NAME_FIELD);
map.put("scheduledAuditArn", SCHEDULED_AUDIT_ARN_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeScheduledAuditResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IotResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* How often the scheduled audit takes place, either one of DAILY, WEEKLY,
* BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.
*
*
* @param frequency
* How often the scheduled audit takes place, either one of DAILY, WEEKLY,
* BIWEEKLY, or MONTHLY. The start time of each audit is determined by the
* system.
* @see AuditFrequency
* @return Returns a reference to this object so that method calls can be chained together.
* @see AuditFrequency
*/
Builder frequency(String frequency);
/**
*
* How often the scheduled audit takes place, either one of DAILY, WEEKLY,
* BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.
*
*
* @param frequency
* How often the scheduled audit takes place, either one of DAILY, WEEKLY,
* BIWEEKLY, or MONTHLY. The start time of each audit is determined by the
* system.
* @see AuditFrequency
* @return Returns a reference to this object so that method calls can be chained together.
* @see AuditFrequency
*/
Builder frequency(AuditFrequency frequency);
/**
*
* The day of the month on which the scheduled audit takes place. This is will be 1 through
* 31 or LAST. If days 29-31 are specified, and the month
* does not have that many days, the audit takes place on the LAST day of the month.
*
*
* @param dayOfMonth
* The day of the month on which the scheduled audit takes place. This is will be 1 through
* 31 or LAST. If days 29-31 are specified, and the
* month does not have that many days, the audit takes place on the LAST day of the month.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dayOfMonth(String dayOfMonth);
/**
*
* The day of the week on which the scheduled audit takes place, either one of SUN,
* MON, TUE, WED, THU, FRI, or SAT
* .
*
*
* @param dayOfWeek
* The day of the week on which the scheduled audit takes place, either one of SUN,
* MON, TUE, WED, THU, FRI, or
* SAT.
* @see DayOfWeek
* @return Returns a reference to this object so that method calls can be chained together.
* @see DayOfWeek
*/
Builder dayOfWeek(String dayOfWeek);
/**
*
* The day of the week on which the scheduled audit takes place, either one of SUN,
* MON, TUE, WED, THU, FRI, or SAT
* .
*
*
* @param dayOfWeek
* The day of the week on which the scheduled audit takes place, either one of SUN,
* MON, TUE, WED, THU, FRI, or
* SAT.
* @see DayOfWeek
* @return Returns a reference to this object so that method calls can be chained together.
* @see DayOfWeek
*/
Builder dayOfWeek(DayOfWeek dayOfWeek);
/**
*
* Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use
* DescribeAccountAuditConfiguration to see the list of all checks, including those that are
* enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
*
*
* @param targetCheckNames
* Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use
* DescribeAccountAuditConfiguration to see the list of all checks, including those that are
* enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetCheckNames(Collection targetCheckNames);
/**
*
* Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use
* DescribeAccountAuditConfiguration to see the list of all checks, including those that are
* enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
*
*
* @param targetCheckNames
* Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use
* DescribeAccountAuditConfiguration to see the list of all checks, including those that are
* enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetCheckNames(String... targetCheckNames);
/**
*
* The name of the scheduled audit.
*
*
* @param scheduledAuditName
* The name of the scheduled audit.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder scheduledAuditName(String scheduledAuditName);
/**
*
* The ARN of the scheduled audit.
*
*
* @param scheduledAuditArn
* The ARN of the scheduled audit.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder scheduledAuditArn(String scheduledAuditArn);
}
static final class BuilderImpl extends IotResponse.BuilderImpl implements Builder {
private String frequency;
private String dayOfMonth;
private String dayOfWeek;
private List targetCheckNames = DefaultSdkAutoConstructList.getInstance();
private String scheduledAuditName;
private String scheduledAuditArn;
private BuilderImpl() {
}
private BuilderImpl(DescribeScheduledAuditResponse model) {
super(model);
frequency(model.frequency);
dayOfMonth(model.dayOfMonth);
dayOfWeek(model.dayOfWeek);
targetCheckNames(model.targetCheckNames);
scheduledAuditName(model.scheduledAuditName);
scheduledAuditArn(model.scheduledAuditArn);
}
public final String getFrequency() {
return frequency;
}
public final void setFrequency(String frequency) {
this.frequency = frequency;
}
@Override
public final Builder frequency(String frequency) {
this.frequency = frequency;
return this;
}
@Override
public final Builder frequency(AuditFrequency frequency) {
this.frequency(frequency == null ? null : frequency.toString());
return this;
}
public final String getDayOfMonth() {
return dayOfMonth;
}
public final void setDayOfMonth(String dayOfMonth) {
this.dayOfMonth = dayOfMonth;
}
@Override
public final Builder dayOfMonth(String dayOfMonth) {
this.dayOfMonth = dayOfMonth;
return this;
}
public final String getDayOfWeek() {
return dayOfWeek;
}
public final void setDayOfWeek(String dayOfWeek) {
this.dayOfWeek = dayOfWeek;
}
@Override
public final Builder dayOfWeek(String dayOfWeek) {
this.dayOfWeek = dayOfWeek;
return this;
}
@Override
public final Builder dayOfWeek(DayOfWeek dayOfWeek) {
this.dayOfWeek(dayOfWeek == null ? null : dayOfWeek.toString());
return this;
}
public final Collection getTargetCheckNames() {
if (targetCheckNames instanceof SdkAutoConstructList) {
return null;
}
return targetCheckNames;
}
public final void setTargetCheckNames(Collection targetCheckNames) {
this.targetCheckNames = TargetAuditCheckNamesCopier.copy(targetCheckNames);
}
@Override
public final Builder targetCheckNames(Collection targetCheckNames) {
this.targetCheckNames = TargetAuditCheckNamesCopier.copy(targetCheckNames);
return this;
}
@Override
@SafeVarargs
public final Builder targetCheckNames(String... targetCheckNames) {
targetCheckNames(Arrays.asList(targetCheckNames));
return this;
}
public final String getScheduledAuditName() {
return scheduledAuditName;
}
public final void setScheduledAuditName(String scheduledAuditName) {
this.scheduledAuditName = scheduledAuditName;
}
@Override
public final Builder scheduledAuditName(String scheduledAuditName) {
this.scheduledAuditName = scheduledAuditName;
return this;
}
public final String getScheduledAuditArn() {
return scheduledAuditArn;
}
public final void setScheduledAuditArn(String scheduledAuditArn) {
this.scheduledAuditArn = scheduledAuditArn;
}
@Override
public final Builder scheduledAuditArn(String scheduledAuditArn) {
this.scheduledAuditArn = scheduledAuditArn;
return this;
}
@Override
public DescribeScheduledAuditResponse build() {
return new DescribeScheduledAuditResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}