com.amazonaws.services.bedrockagent.model.UpdatePromptRequest Maven / Gradle / Ivy
/*
* Copyright 2019-2024 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 com.amazonaws.services.bedrockagent.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UpdatePromptRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
*
*/
private String customerEncryptionKeyArn;
/**
*
* The name of the default variant for the prompt. This value must match the name field in the relevant
* PromptVariant
* object.
*
*/
private String defaultVariant;
/**
*
* A description for the prompt.
*
*/
private String description;
/**
*
* A name for the prompt.
*
*/
private String name;
/**
*
* The unique identifier of the prompt.
*
*/
private String promptIdentifier;
/**
*
* A list of objects, each containing details about a variant of the prompt.
*
*/
private java.util.List variants;
/**
*
* The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
*
*
* @param customerEncryptionKeyArn
* The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
*/
public void setCustomerEncryptionKeyArn(String customerEncryptionKeyArn) {
this.customerEncryptionKeyArn = customerEncryptionKeyArn;
}
/**
*
* The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
*
*
* @return The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
*/
public String getCustomerEncryptionKeyArn() {
return this.customerEncryptionKeyArn;
}
/**
*
* The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
*
*
* @param customerEncryptionKeyArn
* The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdatePromptRequest withCustomerEncryptionKeyArn(String customerEncryptionKeyArn) {
setCustomerEncryptionKeyArn(customerEncryptionKeyArn);
return this;
}
/**
*
* The name of the default variant for the prompt. This value must match the name field in the relevant
* PromptVariant
* object.
*
*
* @param defaultVariant
* The name of the default variant for the prompt. This value must match the name field in the
* relevant
* PromptVariant object.
*/
public void setDefaultVariant(String defaultVariant) {
this.defaultVariant = defaultVariant;
}
/**
*
* The name of the default variant for the prompt. This value must match the name field in the relevant
* PromptVariant
* object.
*
*
* @return The name of the default variant for the prompt. This value must match the name field in the
* relevant
* PromptVariant object.
*/
public String getDefaultVariant() {
return this.defaultVariant;
}
/**
*
* The name of the default variant for the prompt. This value must match the name field in the relevant
* PromptVariant
* object.
*
*
* @param defaultVariant
* The name of the default variant for the prompt. This value must match the name field in the
* relevant
* PromptVariant object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdatePromptRequest withDefaultVariant(String defaultVariant) {
setDefaultVariant(defaultVariant);
return this;
}
/**
*
* A description for the prompt.
*
*
* @param description
* A description for the prompt.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* A description for the prompt.
*
*
* @return A description for the prompt.
*/
public String getDescription() {
return this.description;
}
/**
*
* A description for the prompt.
*
*
* @param description
* A description for the prompt.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdatePromptRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* A name for the prompt.
*
*
* @param name
* A name for the prompt.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* A name for the prompt.
*
*
* @return A name for the prompt.
*/
public String getName() {
return this.name;
}
/**
*
* A name for the prompt.
*
*
* @param name
* A name for the prompt.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdatePromptRequest withName(String name) {
setName(name);
return this;
}
/**
*
* The unique identifier of the prompt.
*
*
* @param promptIdentifier
* The unique identifier of the prompt.
*/
public void setPromptIdentifier(String promptIdentifier) {
this.promptIdentifier = promptIdentifier;
}
/**
*
* The unique identifier of the prompt.
*
*
* @return The unique identifier of the prompt.
*/
public String getPromptIdentifier() {
return this.promptIdentifier;
}
/**
*
* The unique identifier of the prompt.
*
*
* @param promptIdentifier
* The unique identifier of the prompt.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdatePromptRequest withPromptIdentifier(String promptIdentifier) {
setPromptIdentifier(promptIdentifier);
return this;
}
/**
*
* A list of objects, each containing details about a variant of the prompt.
*
*
* @return A list of objects, each containing details about a variant of the prompt.
*/
public java.util.List getVariants() {
return variants;
}
/**
*
* A list of objects, each containing details about a variant of the prompt.
*
*
* @param variants
* A list of objects, each containing details about a variant of the prompt.
*/
public void setVariants(java.util.Collection variants) {
if (variants == null) {
this.variants = null;
return;
}
this.variants = new java.util.ArrayList(variants);
}
/**
*
* A list of objects, each containing details about a variant of the prompt.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setVariants(java.util.Collection)} or {@link #withVariants(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param variants
* A list of objects, each containing details about a variant of the prompt.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdatePromptRequest withVariants(PromptVariant... variants) {
if (this.variants == null) {
setVariants(new java.util.ArrayList(variants.length));
}
for (PromptVariant ele : variants) {
this.variants.add(ele);
}
return this;
}
/**
*
* A list of objects, each containing details about a variant of the prompt.
*
*
* @param variants
* A list of objects, each containing details about a variant of the prompt.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdatePromptRequest withVariants(java.util.Collection variants) {
setVariants(variants);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCustomerEncryptionKeyArn() != null)
sb.append("CustomerEncryptionKeyArn: ").append(getCustomerEncryptionKeyArn()).append(",");
if (getDefaultVariant() != null)
sb.append("DefaultVariant: ").append(getDefaultVariant()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getPromptIdentifier() != null)
sb.append("PromptIdentifier: ").append(getPromptIdentifier()).append(",");
if (getVariants() != null)
sb.append("Variants: ").append("***Sensitive Data Redacted***");
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UpdatePromptRequest == false)
return false;
UpdatePromptRequest other = (UpdatePromptRequest) obj;
if (other.getCustomerEncryptionKeyArn() == null ^ this.getCustomerEncryptionKeyArn() == null)
return false;
if (other.getCustomerEncryptionKeyArn() != null && other.getCustomerEncryptionKeyArn().equals(this.getCustomerEncryptionKeyArn()) == false)
return false;
if (other.getDefaultVariant() == null ^ this.getDefaultVariant() == null)
return false;
if (other.getDefaultVariant() != null && other.getDefaultVariant().equals(this.getDefaultVariant()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getPromptIdentifier() == null ^ this.getPromptIdentifier() == null)
return false;
if (other.getPromptIdentifier() != null && other.getPromptIdentifier().equals(this.getPromptIdentifier()) == false)
return false;
if (other.getVariants() == null ^ this.getVariants() == null)
return false;
if (other.getVariants() != null && other.getVariants().equals(this.getVariants()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCustomerEncryptionKeyArn() == null) ? 0 : getCustomerEncryptionKeyArn().hashCode());
hashCode = prime * hashCode + ((getDefaultVariant() == null) ? 0 : getDefaultVariant().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getPromptIdentifier() == null) ? 0 : getPromptIdentifier().hashCode());
hashCode = prime * hashCode + ((getVariants() == null) ? 0 : getVariants().hashCode());
return hashCode;
}
@Override
public UpdatePromptRequest clone() {
return (UpdatePromptRequest) super.clone();
}
}