software.amazon.awssdk.services.sagemaker.model.GenerativeAiSettings 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.io.Serializable;
import java.util.Arrays;
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.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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The generative AI settings for the SageMaker Canvas application.
*
*
* Configure these settings for Canvas users starting chats with generative AI foundation models. For more information,
* see Use generative AI with foundation
* models.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class GenerativeAiSettings implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField AMAZON_BEDROCK_ROLE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AmazonBedrockRoleArn").getter(getter(GenerativeAiSettings::amazonBedrockRoleArn))
.setter(setter(Builder::amazonBedrockRoleArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AmazonBedrockRoleArn").build())
.build();
private static final List> SDK_FIELDS = Collections
.unmodifiableList(Arrays.asList(AMAZON_BEDROCK_ROLE_ARN_FIELD));
private static final long serialVersionUID = 1L;
private final String amazonBedrockRoleArn;
private GenerativeAiSettings(BuilderImpl builder) {
this.amazonBedrockRoleArn = builder.amazonBedrockRoleArn;
}
/**
*
* The ARN of an Amazon Web Services IAM role that allows fine-tuning of large language models (LLMs) in Amazon
* Bedrock. The IAM role should have Amazon S3 read and write permissions, as well as a trust relationship that
* establishes bedrock.amazonaws.com as a service principal.
*
*
* @return The ARN of an Amazon Web Services IAM role that allows fine-tuning of large language models (LLMs) in
* Amazon Bedrock. The IAM role should have Amazon S3 read and write permissions, as well as a trust
* relationship that establishes bedrock.amazonaws.com as a service principal.
*/
public final String amazonBedrockRoleArn() {
return amazonBedrockRoleArn;
}
@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 + Objects.hashCode(amazonBedrockRoleArn());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GenerativeAiSettings)) {
return false;
}
GenerativeAiSettings other = (GenerativeAiSettings) obj;
return Objects.equals(amazonBedrockRoleArn(), other.amazonBedrockRoleArn());
}
/**
* 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("GenerativeAiSettings").add("AmazonBedrockRoleArn", amazonBedrockRoleArn()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AmazonBedrockRoleArn":
return Optional.ofNullable(clazz.cast(amazonBedrockRoleArn()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GenerativeAiSettings) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The ARN of an Amazon Web Services IAM role that allows fine-tuning of large language models (LLMs) in Amazon
* Bedrock. The IAM role should have Amazon S3 read and write permissions, as well as a trust relationship that
* establishes bedrock.amazonaws.com as a service principal.
*
*
* @param amazonBedrockRoleArn
* The ARN of an Amazon Web Services IAM role that allows fine-tuning of large language models (LLMs) in
* Amazon Bedrock. The IAM role should have Amazon S3 read and write permissions, as well as a trust
* relationship that establishes bedrock.amazonaws.com as a service principal.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder amazonBedrockRoleArn(String amazonBedrockRoleArn);
}
static final class BuilderImpl implements Builder {
private String amazonBedrockRoleArn;
private BuilderImpl() {
}
private BuilderImpl(GenerativeAiSettings model) {
amazonBedrockRoleArn(model.amazonBedrockRoleArn);
}
public final String getAmazonBedrockRoleArn() {
return amazonBedrockRoleArn;
}
public final void setAmazonBedrockRoleArn(String amazonBedrockRoleArn) {
this.amazonBedrockRoleArn = amazonBedrockRoleArn;
}
@Override
public final Builder amazonBedrockRoleArn(String amazonBedrockRoleArn) {
this.amazonBedrockRoleArn = amazonBedrockRoleArn;
return this;
}
@Override
public GenerativeAiSettings build() {
return new GenerativeAiSettings(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}