software.amazon.awssdk.services.sagemaker.model.CreateProjectRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sagemaker Show documentation
Show all versions of sagemaker Show documentation
The AWS Java SDK for Amazon SageMaker module holds the client classes that are used for communicating
with Amazon SageMaker 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.sagemaker.model;
import java.beans.Transient;
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 CreateProjectRequest extends SageMakerRequest implements
ToCopyableBuilder {
private static final SdkField PROJECT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ProjectName").getter(getter(CreateProjectRequest::projectName)).setter(setter(Builder::projectName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ProjectName").build()).build();
private static final SdkField PROJECT_DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ProjectDescription").getter(getter(CreateProjectRequest::projectDescription))
.setter(setter(Builder::projectDescription))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ProjectDescription").build())
.build();
private static final SdkField SERVICE_CATALOG_PROVISIONING_DETAILS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("ServiceCatalogProvisioningDetails")
.getter(getter(CreateProjectRequest::serviceCatalogProvisioningDetails))
.setter(setter(Builder::serviceCatalogProvisioningDetails))
.constructor(ServiceCatalogProvisioningDetails::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ServiceCatalogProvisioningDetails")
.build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateProjectRequest::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(PROJECT_NAME_FIELD,
PROJECT_DESCRIPTION_FIELD, SERVICE_CATALOG_PROVISIONING_DETAILS_FIELD, TAGS_FIELD));
private final String projectName;
private final String projectDescription;
private final ServiceCatalogProvisioningDetails serviceCatalogProvisioningDetails;
private final List tags;
private CreateProjectRequest(BuilderImpl builder) {
super(builder);
this.projectName = builder.projectName;
this.projectDescription = builder.projectDescription;
this.serviceCatalogProvisioningDetails = builder.serviceCatalogProvisioningDetails;
this.tags = builder.tags;
}
/**
*
* The name of the project.
*
*
* @return The name of the project.
*/
public final String projectName() {
return projectName;
}
/**
*
* A description for the project.
*
*
* @return A description for the project.
*/
public final String projectDescription() {
return projectDescription;
}
/**
*
* The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will
* default to the latest provisioning artifact ID of the product, if you don't provide the provisioning artifact ID.
* For more information, see What is Amazon Web Services
* Service Catalog.
*
*
* @return The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID
* will default to the latest provisioning artifact ID of the product, if you don't provide the provisioning
* artifact ID. For more information, see What is Amazon Web
* Services Service Catalog.
*/
public final ServiceCatalogProvisioningDetails serviceCatalogProvisioningDetails() {
return serviceCatalogProvisioningDetails;
}
/**
* 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);
}
/**
*
* An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource costs.
* For more information, see Tagging Amazon
* Web Services resources in the Amazon Web Services General Reference 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 An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource
* costs. For more information, see Tagging Amazon Web Services
* resources in the Amazon Web Services General Reference Guide.
*/
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(projectName());
hashCode = 31 * hashCode + Objects.hashCode(projectDescription());
hashCode = 31 * hashCode + Objects.hashCode(serviceCatalogProvisioningDetails());
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 CreateProjectRequest)) {
return false;
}
CreateProjectRequest other = (CreateProjectRequest) obj;
return Objects.equals(projectName(), other.projectName())
&& Objects.equals(projectDescription(), other.projectDescription())
&& Objects.equals(serviceCatalogProvisioningDetails(), other.serviceCatalogProvisioningDetails())
&& 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("CreateProjectRequest").add("ProjectName", projectName())
.add("ProjectDescription", projectDescription())
.add("ServiceCatalogProvisioningDetails", serviceCatalogProvisioningDetails())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ProjectName":
return Optional.ofNullable(clazz.cast(projectName()));
case "ProjectDescription":
return Optional.ofNullable(clazz.cast(projectDescription()));
case "ServiceCatalogProvisioningDetails":
return Optional.ofNullable(clazz.cast(serviceCatalogProvisioningDetails()));
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((CreateProjectRequest) 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 project.
*
*
* @param projectName
* The name of the project.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder projectName(String projectName);
/**
*
* A description for the project.
*
*
* @param projectDescription
* A description for the project.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder projectDescription(String projectDescription);
/**
*
* The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will
* default to the latest provisioning artifact ID of the product, if you don't provide the provisioning artifact
* ID. For more information, see What is Amazon Web
* Services Service Catalog.
*
*
* @param serviceCatalogProvisioningDetails
* The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact
* ID will default to the latest provisioning artifact ID of the product, if you don't provide the
* provisioning artifact ID. For more information, see What is Amazon
* Web Services Service Catalog.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder serviceCatalogProvisioningDetails(ServiceCatalogProvisioningDetails serviceCatalogProvisioningDetails);
/**
*
* The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will
* default to the latest provisioning artifact ID of the product, if you don't provide the provisioning artifact
* ID. For more information, see What is Amazon Web
* Services Service Catalog.
*
* This is a convenience that creates an instance of the {@link ServiceCatalogProvisioningDetails.Builder}
* avoiding the need to create one manually via {@link ServiceCatalogProvisioningDetails#builder()}.
*
* When the {@link Consumer} completes, {@link ServiceCatalogProvisioningDetails.Builder#build()} is called
* immediately and its result is passed to
* {@link #serviceCatalogProvisioningDetails(ServiceCatalogProvisioningDetails)}.
*
* @param serviceCatalogProvisioningDetails
* a consumer that will call methods on {@link ServiceCatalogProvisioningDetails.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #serviceCatalogProvisioningDetails(ServiceCatalogProvisioningDetails)
*/
default Builder serviceCatalogProvisioningDetails(
Consumer serviceCatalogProvisioningDetails) {
return serviceCatalogProvisioningDetails(ServiceCatalogProvisioningDetails.builder()
.applyMutation(serviceCatalogProvisioningDetails).build());
}
/**
*
* An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource
* costs. For more information, see Tagging Amazon Web Services
* resources in the Amazon Web Services General Reference Guide.
*
*
* @param tags
* An array of key-value pairs that you want to use to organize and track your Amazon Web Services
* resource costs. For more information, see Tagging Amazon Web Services
* resources in the Amazon Web Services General Reference Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource
* costs. For more information, see Tagging Amazon Web Services
* resources in the Amazon Web Services General Reference Guide.
*
*
* @param tags
* An array of key-value pairs that you want to use to organize and track your Amazon Web Services
* resource costs. For more information, see Tagging Amazon Web Services
* resources in the Amazon Web Services General Reference Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource
* costs. For more information, see Tagging Amazon Web Services
* resources in the Amazon Web Services General Reference Guide.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create
* one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result
* is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(List)
*/
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 projectName;
private String projectDescription;
private ServiceCatalogProvisioningDetails serviceCatalogProvisioningDetails;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateProjectRequest model) {
super(model);
projectName(model.projectName);
projectDescription(model.projectDescription);
serviceCatalogProvisioningDetails(model.serviceCatalogProvisioningDetails);
tags(model.tags);
}
public final String getProjectName() {
return projectName;
}
public final void setProjectName(String projectName) {
this.projectName = projectName;
}
@Override
@Transient
public final Builder projectName(String projectName) {
this.projectName = projectName;
return this;
}
public final String getProjectDescription() {
return projectDescription;
}
public final void setProjectDescription(String projectDescription) {
this.projectDescription = projectDescription;
}
@Override
@Transient
public final Builder projectDescription(String projectDescription) {
this.projectDescription = projectDescription;
return this;
}
public final ServiceCatalogProvisioningDetails.Builder getServiceCatalogProvisioningDetails() {
return serviceCatalogProvisioningDetails != null ? serviceCatalogProvisioningDetails.toBuilder() : null;
}
public final void setServiceCatalogProvisioningDetails(
ServiceCatalogProvisioningDetails.BuilderImpl serviceCatalogProvisioningDetails) {
this.serviceCatalogProvisioningDetails = serviceCatalogProvisioningDetails != null ? serviceCatalogProvisioningDetails
.build() : null;
}
@Override
@Transient
public final Builder serviceCatalogProvisioningDetails(ServiceCatalogProvisioningDetails serviceCatalogProvisioningDetails) {
this.serviceCatalogProvisioningDetails = serviceCatalogProvisioningDetails;
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
@Transient
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@Transient
@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 CreateProjectRequest build() {
return new CreateProjectRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy