software.amazon.awssdk.services.sagemaker.model.CreateClusterRequest Maven / Gradle / Ivy
Show all versions of sagemaker 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.sagemaker.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.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 CreateClusterRequest extends SageMakerRequest implements
ToCopyableBuilder {
private static final SdkField CLUSTER_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ClusterName").getter(getter(CreateClusterRequest::clusterName)).setter(setter(Builder::clusterName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClusterName").build()).build();
private static final SdkField> INSTANCE_GROUPS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("InstanceGroups")
.getter(getter(CreateClusterRequest::instanceGroups))
.setter(setter(Builder::instanceGroups))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InstanceGroups").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ClusterInstanceGroupSpecification::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField VPC_CONFIG_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("VpcConfig").getter(getter(CreateClusterRequest::vpcConfig)).setter(setter(Builder::vpcConfig))
.constructor(VpcConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VpcConfig").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateClusterRequest::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 SdkField ORCHESTRATOR_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Orchestrator")
.getter(getter(CreateClusterRequest::orchestrator)).setter(setter(Builder::orchestrator))
.constructor(ClusterOrchestrator::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Orchestrator").build()).build();
private static final SdkField NODE_RECOVERY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NodeRecovery").getter(getter(CreateClusterRequest::nodeRecoveryAsString))
.setter(setter(Builder::nodeRecovery))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NodeRecovery").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CLUSTER_NAME_FIELD,
INSTANCE_GROUPS_FIELD, VPC_CONFIG_FIELD, TAGS_FIELD, ORCHESTRATOR_FIELD, NODE_RECOVERY_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String clusterName;
private final List instanceGroups;
private final VpcConfig vpcConfig;
private final List tags;
private final ClusterOrchestrator orchestrator;
private final String nodeRecovery;
private CreateClusterRequest(BuilderImpl builder) {
super(builder);
this.clusterName = builder.clusterName;
this.instanceGroups = builder.instanceGroups;
this.vpcConfig = builder.vpcConfig;
this.tags = builder.tags;
this.orchestrator = builder.orchestrator;
this.nodeRecovery = builder.nodeRecovery;
}
/**
*
* The name for the new SageMaker HyperPod cluster.
*
*
* @return The name for the new SageMaker HyperPod cluster.
*/
public final String clusterName() {
return clusterName;
}
/**
* For responses, this returns true if the service returned a value for the InstanceGroups 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 hasInstanceGroups() {
return instanceGroups != null && !(instanceGroups instanceof SdkAutoConstructList);
}
/**
*
* The instance groups to be created in the SageMaker HyperPod cluster.
*
*
* 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 #hasInstanceGroups} method.
*
*
* @return The instance groups to be created in the SageMaker HyperPod cluster.
*/
public final List instanceGroups() {
return instanceGroups;
}
/**
* Returns the value of the VpcConfig property for this object.
*
* @return The value of the VpcConfig property for this object.
*/
public final VpcConfig vpcConfig() {
return vpcConfig;
}
/**
* 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);
}
/**
*
* Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to
* your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn
* more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources
* User Guide.
*
*
* 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 Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add
* tags to your cluster in the same way you add them in other Amazon Web Services services that support
* tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services
* Resources User Guide.
*/
public final List tags() {
return tags;
}
/**
*
* The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, the only supported value is
* "eks"
, which is to use an Amazon Elastic Kubernetes Service (EKS) cluster as the orchestrator.
*
*
* @return The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, the only supported value
* is "eks"
, which is to use an Amazon Elastic Kubernetes Service (EKS) cluster as the
* orchestrator.
*/
public final ClusterOrchestrator orchestrator() {
return orchestrator;
}
/**
*
* The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic
, SageMaker HyperPod
* will automatically reboot or replace faulty nodes when issues are detected. When set to None
,
* cluster administrators will need to manually manage any faulty cluster instances.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #nodeRecovery} will
* return {@link ClusterNodeRecovery#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #nodeRecoveryAsString}.
*
*
* @return The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic
, SageMaker
* HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set to
* None
, cluster administrators will need to manually manage any faulty cluster instances.
* @see ClusterNodeRecovery
*/
public final ClusterNodeRecovery nodeRecovery() {
return ClusterNodeRecovery.fromValue(nodeRecovery);
}
/**
*
* The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic
, SageMaker HyperPod
* will automatically reboot or replace faulty nodes when issues are detected. When set to None
,
* cluster administrators will need to manually manage any faulty cluster instances.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #nodeRecovery} will
* return {@link ClusterNodeRecovery#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #nodeRecoveryAsString}.
*
*
* @return The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic
, SageMaker
* HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set to
* None
, cluster administrators will need to manually manage any faulty cluster instances.
* @see ClusterNodeRecovery
*/
public final String nodeRecoveryAsString() {
return nodeRecovery;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(clusterName());
hashCode = 31 * hashCode + Objects.hashCode(hasInstanceGroups() ? instanceGroups() : null);
hashCode = 31 * hashCode + Objects.hashCode(vpcConfig());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(orchestrator());
hashCode = 31 * hashCode + Objects.hashCode(nodeRecoveryAsString());
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 CreateClusterRequest)) {
return false;
}
CreateClusterRequest other = (CreateClusterRequest) obj;
return Objects.equals(clusterName(), other.clusterName()) && hasInstanceGroups() == other.hasInstanceGroups()
&& Objects.equals(instanceGroups(), other.instanceGroups()) && Objects.equals(vpcConfig(), other.vpcConfig())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags())
&& Objects.equals(orchestrator(), other.orchestrator())
&& Objects.equals(nodeRecoveryAsString(), other.nodeRecoveryAsString());
}
/**
* 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("CreateClusterRequest").add("ClusterName", clusterName())
.add("InstanceGroups", hasInstanceGroups() ? instanceGroups() : null).add("VpcConfig", vpcConfig())
.add("Tags", hasTags() ? tags() : null).add("Orchestrator", orchestrator())
.add("NodeRecovery", nodeRecoveryAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ClusterName":
return Optional.ofNullable(clazz.cast(clusterName()));
case "InstanceGroups":
return Optional.ofNullable(clazz.cast(instanceGroups()));
case "VpcConfig":
return Optional.ofNullable(clazz.cast(vpcConfig()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
case "Orchestrator":
return Optional.ofNullable(clazz.cast(orchestrator()));
case "NodeRecovery":
return Optional.ofNullable(clazz.cast(nodeRecoveryAsString()));
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("ClusterName", CLUSTER_NAME_FIELD);
map.put("InstanceGroups", INSTANCE_GROUPS_FIELD);
map.put("VpcConfig", VPC_CONFIG_FIELD);
map.put("Tags", TAGS_FIELD);
map.put("Orchestrator", ORCHESTRATOR_FIELD);
map.put("NodeRecovery", NODE_RECOVERY_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function