software.amazon.awssdk.services.sagemaker.model.CreateEdgeDeploymentPlanRequest 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.sagemaker.model;
import java.util.Arrays;
import java.util.Collection;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
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.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 CreateEdgeDeploymentPlanRequest extends SageMakerRequest implements
ToCopyableBuilder {
private static final SdkField EDGE_DEPLOYMENT_PLAN_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EdgeDeploymentPlanName").getter(getter(CreateEdgeDeploymentPlanRequest::edgeDeploymentPlanName))
.setter(setter(Builder::edgeDeploymentPlanName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EdgeDeploymentPlanName").build())
.build();
private static final SdkField> MODEL_CONFIGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ModelConfigs")
.getter(getter(CreateEdgeDeploymentPlanRequest::modelConfigs))
.setter(setter(Builder::modelConfigs))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ModelConfigs").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(EdgeDeploymentModelConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField DEVICE_FLEET_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DeviceFleetName").getter(getter(CreateEdgeDeploymentPlanRequest::deviceFleetName))
.setter(setter(Builder::deviceFleetName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeviceFleetName").build()).build();
private static final SdkField> STAGES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Stages")
.getter(getter(CreateEdgeDeploymentPlanRequest::stages))
.setter(setter(Builder::stages))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Stages").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(DeploymentStage::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateEdgeDeploymentPlanRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
EDGE_DEPLOYMENT_PLAN_NAME_FIELD, MODEL_CONFIGS_FIELD, DEVICE_FLEET_NAME_FIELD, STAGES_FIELD, TAGS_FIELD));
private final String edgeDeploymentPlanName;
private final List modelConfigs;
private final String deviceFleetName;
private final List stages;
private final List tags;
private CreateEdgeDeploymentPlanRequest(BuilderImpl builder) {
super(builder);
this.edgeDeploymentPlanName = builder.edgeDeploymentPlanName;
this.modelConfigs = builder.modelConfigs;
this.deviceFleetName = builder.deviceFleetName;
this.stages = builder.stages;
this.tags = builder.tags;
}
/**
*
* The name of the edge deployment plan.
*
*
* @return The name of the edge deployment plan.
*/
public final String edgeDeploymentPlanName() {
return edgeDeploymentPlanName;
}
/**
* For responses, this returns true if the service returned a value for the ModelConfigs 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 hasModelConfigs() {
return modelConfigs != null && !(modelConfigs instanceof SdkAutoConstructList);
}
/**
*
* List of models associated with the edge deployment plan.
*
*
* 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 #hasModelConfigs} method.
*
*
* @return List of models associated with the edge deployment plan.
*/
public final List modelConfigs() {
return modelConfigs;
}
/**
*
* The device fleet used for this edge deployment plan.
*
*
* @return The device fleet used for this edge deployment plan.
*/
public final String deviceFleetName() {
return deviceFleetName;
}
/**
* For responses, this returns true if the service returned a value for the Stages 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 hasStages() {
return stages != null && !(stages instanceof SdkAutoConstructList);
}
/**
*
* List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.
*
*
* 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 #hasStages} method.
*
*
* @return List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.
*/
public final List stages() {
return stages;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* List of tags with which to tag the edge deployment plan.
*
*
* 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 #hasTags} method.
*
*
* @return List of tags with which to tag the edge deployment plan.
*/
public final List tags() {
return tags;
}
@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(edgeDeploymentPlanName());
hashCode = 31 * hashCode + Objects.hashCode(hasModelConfigs() ? modelConfigs() : null);
hashCode = 31 * hashCode + Objects.hashCode(deviceFleetName());
hashCode = 31 * hashCode + Objects.hashCode(hasStages() ? stages() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
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 CreateEdgeDeploymentPlanRequest)) {
return false;
}
CreateEdgeDeploymentPlanRequest other = (CreateEdgeDeploymentPlanRequest) obj;
return Objects.equals(edgeDeploymentPlanName(), other.edgeDeploymentPlanName())
&& hasModelConfigs() == other.hasModelConfigs() && Objects.equals(modelConfigs(), other.modelConfigs())
&& Objects.equals(deviceFleetName(), other.deviceFleetName()) && hasStages() == other.hasStages()
&& Objects.equals(stages(), other.stages()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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("CreateEdgeDeploymentPlanRequest").add("EdgeDeploymentPlanName", edgeDeploymentPlanName())
.add("ModelConfigs", hasModelConfigs() ? modelConfigs() : null).add("DeviceFleetName", deviceFleetName())
.add("Stages", hasStages() ? stages() : null).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "EdgeDeploymentPlanName":
return Optional.ofNullable(clazz.cast(edgeDeploymentPlanName()));
case "ModelConfigs":
return Optional.ofNullable(clazz.cast(modelConfigs()));
case "DeviceFleetName":
return Optional.ofNullable(clazz.cast(deviceFleetName()));
case "Stages":
return Optional.ofNullable(clazz.cast(stages()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateEdgeDeploymentPlanRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the edge deployment plan.
*
*
* @param edgeDeploymentPlanName
* The name of the edge deployment plan.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder edgeDeploymentPlanName(String edgeDeploymentPlanName);
/**
*
* List of models associated with the edge deployment plan.
*
*
* @param modelConfigs
* List of models associated with the edge deployment plan.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder modelConfigs(Collection modelConfigs);
/**
*
* List of models associated with the edge deployment plan.
*
*
* @param modelConfigs
* List of models associated with the edge deployment plan.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder modelConfigs(EdgeDeploymentModelConfig... modelConfigs);
/**
*
* List of models associated with the edge deployment plan.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.sagemaker.model.EdgeDeploymentModelConfig.Builder} avoiding the need
* to create one manually via
* {@link software.amazon.awssdk.services.sagemaker.model.EdgeDeploymentModelConfig#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.sagemaker.model.EdgeDeploymentModelConfig.Builder#build()} is called
* immediately and its result is passed to {@link #modelConfigs(List)}.
*
* @param modelConfigs
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.sagemaker.model.EdgeDeploymentModelConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #modelConfigs(java.util.Collection)
*/
Builder modelConfigs(Consumer... modelConfigs);
/**
*
* The device fleet used for this edge deployment plan.
*
*
* @param deviceFleetName
* The device fleet used for this edge deployment plan.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deviceFleetName(String deviceFleetName);
/**
*
* List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.
*
*
* @param stages
* List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stages(Collection stages);
/**
*
* List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.
*
*
* @param stages
* List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stages(DeploymentStage... stages);
/**
*
* List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.sagemaker.model.DeploymentStage.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.sagemaker.model.DeploymentStage#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.sagemaker.model.DeploymentStage.Builder#build()} is called immediately
* and its result is passed to {@link #stages(List)}.
*
* @param stages
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.sagemaker.model.DeploymentStage.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #stages(java.util.Collection)
*/
Builder stages(Consumer... stages);
/**
*
* List of tags with which to tag the edge deployment plan.
*
*
* @param tags
* List of tags with which to tag the edge deployment plan.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* List of tags with which to tag the edge deployment plan.
*
*
* @param tags
* List of tags with which to tag the edge deployment plan.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* List of tags with which to tag the edge deployment plan.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.sagemaker.model.Tag.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.sagemaker.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.sagemaker.model.Tag.Builder#build()} is called immediately and its
* result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.sagemaker.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SageMakerRequest.BuilderImpl implements Builder {
private String edgeDeploymentPlanName;
private List modelConfigs = DefaultSdkAutoConstructList.getInstance();
private String deviceFleetName;
private List stages = DefaultSdkAutoConstructList.getInstance();
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateEdgeDeploymentPlanRequest model) {
super(model);
edgeDeploymentPlanName(model.edgeDeploymentPlanName);
modelConfigs(model.modelConfigs);
deviceFleetName(model.deviceFleetName);
stages(model.stages);
tags(model.tags);
}
public final String getEdgeDeploymentPlanName() {
return edgeDeploymentPlanName;
}
public final void setEdgeDeploymentPlanName(String edgeDeploymentPlanName) {
this.edgeDeploymentPlanName = edgeDeploymentPlanName;
}
@Override
public final Builder edgeDeploymentPlanName(String edgeDeploymentPlanName) {
this.edgeDeploymentPlanName = edgeDeploymentPlanName;
return this;
}
public final List getModelConfigs() {
List result = EdgeDeploymentModelConfigsCopier.copyToBuilder(this.modelConfigs);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setModelConfigs(Collection modelConfigs) {
this.modelConfigs = EdgeDeploymentModelConfigsCopier.copyFromBuilder(modelConfigs);
}
@Override
public final Builder modelConfigs(Collection modelConfigs) {
this.modelConfigs = EdgeDeploymentModelConfigsCopier.copy(modelConfigs);
return this;
}
@Override
@SafeVarargs
public final Builder modelConfigs(EdgeDeploymentModelConfig... modelConfigs) {
modelConfigs(Arrays.asList(modelConfigs));
return this;
}
@Override
@SafeVarargs
public final Builder modelConfigs(Consumer... modelConfigs) {
modelConfigs(Stream.of(modelConfigs).map(c -> EdgeDeploymentModelConfig.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getDeviceFleetName() {
return deviceFleetName;
}
public final void setDeviceFleetName(String deviceFleetName) {
this.deviceFleetName = deviceFleetName;
}
@Override
public final Builder deviceFleetName(String deviceFleetName) {
this.deviceFleetName = deviceFleetName;
return this;
}
public final List getStages() {
List result = DeploymentStagesCopier.copyToBuilder(this.stages);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setStages(Collection stages) {
this.stages = DeploymentStagesCopier.copyFromBuilder(stages);
}
@Override
public final Builder stages(Collection stages) {
this.stages = DeploymentStagesCopier.copy(stages);
return this;
}
@Override
@SafeVarargs
public final Builder stages(DeploymentStage... stages) {
stages(Arrays.asList(stages));
return this;
}
@Override
@SafeVarargs
public final Builder stages(Consumer... stages) {
stages(Stream.of(stages).map(c -> DeploymentStage.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateEdgeDeploymentPlanRequest build() {
return new CreateEdgeDeploymentPlanRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}