software.amazon.awssdk.services.ssm.model.MaintenanceWindowAutomationParameters Maven / Gradle / Ivy
/*
* Copyright 2014-2019 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.ssm.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
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.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The parameters for an AUTOMATION task type.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class MaintenanceWindowAutomationParameters implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField DOCUMENT_VERSION_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(MaintenanceWindowAutomationParameters::documentVersion)).setter(setter(Builder::documentVersion))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DocumentVersion").build()).build();
private static final SdkField>> PARAMETERS_FIELD = SdkField
.>> builder(MarshallingType.MAP)
.getter(getter(MaintenanceWindowAutomationParameters::parameters))
.setter(setter(Builder::parameters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Parameters").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField.> builder(MarshallingType.LIST)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder()
.location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build())
.build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DOCUMENT_VERSION_FIELD,
PARAMETERS_FIELD));
private static final long serialVersionUID = 1L;
private final String documentVersion;
private final Map> parameters;
private MaintenanceWindowAutomationParameters(BuilderImpl builder) {
this.documentVersion = builder.documentVersion;
this.parameters = builder.parameters;
}
/**
*
* The version of an Automation document to use during task execution.
*
*
* @return The version of an Automation document to use during task execution.
*/
public String documentVersion() {
return documentVersion;
}
/**
*
* The parameters for the AUTOMATION task.
*
*
* For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and
* UpdateMaintenanceWindowTask.
*
*
*
* LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the
* OutputS3BucketName and OutputS3KeyPrefix options in the
* TaskInvocationParameters structure. For information about how Systems Manager handles these options
* for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
*
*
* TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead
* use the Parameters option in the TaskInvocationParameters structure. For information
* about how Systems Manager handles these options for the supported maintenance window task types, see
* MaintenanceWindowTaskInvocationParameters.
*
*
* For AUTOMATION task types, Systems Manager ignores any values specified for these parameters.
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return The parameters for the AUTOMATION task.
*
* For information about specifying and updating task parameters, see
* RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.
*
*
*
* LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the
* OutputS3BucketName and OutputS3KeyPrefix options in the
* TaskInvocationParameters structure. For information about how Systems Manager handles these
* options for the supported maintenance window task types, see
* MaintenanceWindowTaskInvocationParameters.
*
*
* TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,
* instead use the Parameters option in the TaskInvocationParameters structure.
* For information about how Systems Manager handles these options for the supported maintenance window task
* types, see MaintenanceWindowTaskInvocationParameters.
*
*
* For AUTOMATION task types, Systems Manager ignores any values specified for these parameters.
*
*/
public Map> parameters() {
return parameters;
}
@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 + Objects.hashCode(documentVersion());
hashCode = 31 * hashCode + Objects.hashCode(parameters());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof MaintenanceWindowAutomationParameters)) {
return false;
}
MaintenanceWindowAutomationParameters other = (MaintenanceWindowAutomationParameters) obj;
return Objects.equals(documentVersion(), other.documentVersion()) && Objects.equals(parameters(), other.parameters());
}
/**
* 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("MaintenanceWindowAutomationParameters").add("DocumentVersion", documentVersion())
.add("Parameters", parameters()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DocumentVersion":
return Optional.ofNullable(clazz.cast(documentVersion()));
case "Parameters":
return Optional.ofNullable(clazz.cast(parameters()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((MaintenanceWindowAutomationParameters) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The version of an Automation document to use during task execution.
*
*
* @param documentVersion
* The version of an Automation document to use during task execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder documentVersion(String documentVersion);
/**
*
* The parameters for the AUTOMATION task.
*
*
* For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow
* and UpdateMaintenanceWindowTask.
*
*
*
* LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the
* OutputS3BucketName and OutputS3KeyPrefix options in the
* TaskInvocationParameters structure. For information about how Systems Manager handles these
* options for the supported maintenance window task types, see
* MaintenanceWindowTaskInvocationParameters.
*
*
* TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,
* instead use the Parameters option in the TaskInvocationParameters structure. For
* information about how Systems Manager handles these options for the supported maintenance window task types,
* see MaintenanceWindowTaskInvocationParameters.
*
*
* For AUTOMATION task types, Systems Manager ignores any values specified for these parameters.
*
*
*
* @param parameters
* The parameters for the AUTOMATION task.
*
* For information about specifying and updating task parameters, see
* RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.
*
*
*
* LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the
* OutputS3BucketName and OutputS3KeyPrefix options in the
* TaskInvocationParameters structure. For information about how Systems Manager handles
* these options for the supported maintenance window task types, see
* MaintenanceWindowTaskInvocationParameters.
*
*
* TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,
* instead use the Parameters option in the TaskInvocationParameters structure.
* For information about how Systems Manager handles these options for the supported maintenance window
* task types, see MaintenanceWindowTaskInvocationParameters.
*
*
* For AUTOMATION task types, Systems Manager ignores any values specified for these parameters.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder parameters(Map> parameters);
}
static final class BuilderImpl implements Builder {
private String documentVersion;
private Map> parameters = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(MaintenanceWindowAutomationParameters model) {
documentVersion(model.documentVersion);
parameters(model.parameters);
}
public final String getDocumentVersion() {
return documentVersion;
}
@Override
public final Builder documentVersion(String documentVersion) {
this.documentVersion = documentVersion;
return this;
}
public final void setDocumentVersion(String documentVersion) {
this.documentVersion = documentVersion;
}
public final Map> getParameters() {
return parameters;
}
@Override
public final Builder parameters(Map> parameters) {
this.parameters = AutomationParameterMapCopier.copy(parameters);
return this;
}
public final void setParameters(Map> parameters) {
this.parameters = AutomationParameterMapCopier.copy(parameters);
}
@Override
public MaintenanceWindowAutomationParameters build() {
return new MaintenanceWindowAutomationParameters(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}