com.amazonaws.services.forecast.model.CreateExplainabilityExportRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-forecast Show documentation
/*
* 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.forecast.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 CreateExplainabilityExportRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A unique name for the Explainability export.
*
*/
private String explainabilityExportName;
/**
*
* The Amazon Resource Name (ARN) of the Explainability to export.
*
*/
private String explainabilityArn;
private DataDestination destination;
/**
*
* Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional
* value, both of which you define. Tag keys and values are case sensitive.
*
*
* The following restrictions apply to tags:
*
*
* -
*
* For each resource, each tag key must be unique and each tag key must have one value.
*
*
* -
*
* Maximum number of tags per resource: 50.
*
*
* -
*
* Maximum key length: 128 Unicode characters in UTF-8.
*
*
* -
*
* Maximum value length: 256 Unicode characters in UTF-8.
*
*
* -
*
* Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging
* schema is used across other services and resources, the character restrictions of those services also apply.
*
*
* -
*
* Key prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values
* can have this prefix. If a tag value has aws as its prefix but the key does not, Forecast considers
* it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of
* aws do not count against your tags per resource limit. You cannot edit or delete tag keys with this
* prefix.
*
*
*
*/
private java.util.List tags;
/**
*
* The format of the exported data, CSV or PARQUET.
*
*/
private String format;
/**
*
* A unique name for the Explainability export.
*
*
* @param explainabilityExportName
* A unique name for the Explainability export.
*/
public void setExplainabilityExportName(String explainabilityExportName) {
this.explainabilityExportName = explainabilityExportName;
}
/**
*
* A unique name for the Explainability export.
*
*
* @return A unique name for the Explainability export.
*/
public String getExplainabilityExportName() {
return this.explainabilityExportName;
}
/**
*
* A unique name for the Explainability export.
*
*
* @param explainabilityExportName
* A unique name for the Explainability export.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateExplainabilityExportRequest withExplainabilityExportName(String explainabilityExportName) {
setExplainabilityExportName(explainabilityExportName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the Explainability to export.
*
*
* @param explainabilityArn
* The Amazon Resource Name (ARN) of the Explainability to export.
*/
public void setExplainabilityArn(String explainabilityArn) {
this.explainabilityArn = explainabilityArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Explainability to export.
*
*
* @return The Amazon Resource Name (ARN) of the Explainability to export.
*/
public String getExplainabilityArn() {
return this.explainabilityArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Explainability to export.
*
*
* @param explainabilityArn
* The Amazon Resource Name (ARN) of the Explainability to export.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateExplainabilityExportRequest withExplainabilityArn(String explainabilityArn) {
setExplainabilityArn(explainabilityArn);
return this;
}
/**
* @param destination
*/
public void setDestination(DataDestination destination) {
this.destination = destination;
}
/**
* @return
*/
public DataDestination getDestination() {
return this.destination;
}
/**
* @param destination
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateExplainabilityExportRequest withDestination(DataDestination destination) {
setDestination(destination);
return this;
}
/**
*
* Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional
* value, both of which you define. Tag keys and values are case sensitive.
*
*
* The following restrictions apply to tags:
*
*
* -
*
* For each resource, each tag key must be unique and each tag key must have one value.
*
*
* -
*
* Maximum number of tags per resource: 50.
*
*
* -
*
* Maximum key length: 128 Unicode characters in UTF-8.
*
*
* -
*
* Maximum value length: 256 Unicode characters in UTF-8.
*
*
* -
*
* Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging
* schema is used across other services and resources, the character restrictions of those services also apply.
*
*
* -
*
* Key prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values
* can have this prefix. If a tag value has aws as its prefix but the key does not, Forecast considers
* it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of
* aws do not count against your tags per resource limit. You cannot edit or delete tag keys with this
* prefix.
*
*
*
*
* @return Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an
* optional value, both of which you define. Tag keys and values are case sensitive.
*
* The following restrictions apply to tags:
*
*
* -
*
* For each resource, each tag key must be unique and each tag key must have one value.
*
*
* -
*
* Maximum number of tags per resource: 50.
*
*
* -
*
* Maximum key length: 128 Unicode characters in UTF-8.
*
*
* -
*
* Maximum value length: 256 Unicode characters in UTF-8.
*
*
* -
*
* Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your
* tagging schema is used across other services and resources, the character restrictions of those services
* also apply.
*
*
* -
*
* Key prefixes cannot include any upper or lowercase combination of aws: or AWS:.
* Values can have this prefix. If a tag value has aws as its prefix but the key does not,
* Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the
* key prefix of aws do not count against your tags per resource limit. You cannot edit or
* delete tag keys with this prefix.
*
*
*/
public java.util.List getTags() {
return tags;
}
/**
*
* Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional
* value, both of which you define. Tag keys and values are case sensitive.
*
*
* The following restrictions apply to tags:
*
*
* -
*
* For each resource, each tag key must be unique and each tag key must have one value.
*
*
* -
*
* Maximum number of tags per resource: 50.
*
*
* -
*
* Maximum key length: 128 Unicode characters in UTF-8.
*
*
* -
*
* Maximum value length: 256 Unicode characters in UTF-8.
*
*
* -
*
* Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging
* schema is used across other services and resources, the character restrictions of those services also apply.
*
*
* -
*
* Key prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values
* can have this prefix. If a tag value has aws as its prefix but the key does not, Forecast considers
* it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of
* aws do not count against your tags per resource limit. You cannot edit or delete tag keys with this
* prefix.
*
*
*
*
* @param tags
* Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an
* optional value, both of which you define. Tag keys and values are case sensitive.
*
* The following restrictions apply to tags:
*
*
* -
*
* For each resource, each tag key must be unique and each tag key must have one value.
*
*
* -
*
* Maximum number of tags per resource: 50.
*
*
* -
*
* Maximum key length: 128 Unicode characters in UTF-8.
*
*
* -
*
* Maximum value length: 256 Unicode characters in UTF-8.
*
*
* -
*
* Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your
* tagging schema is used across other services and resources, the character restrictions of those services
* also apply.
*
*
* -
*
* Key prefixes cannot include any upper or lowercase combination of aws: or AWS:.
* Values can have this prefix. If a tag value has aws as its prefix but the key does not,
* Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key
* prefix of aws do not count against your tags per resource limit. You cannot edit or delete
* tag keys with this prefix.
*
*
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional
* value, both of which you define. Tag keys and values are case sensitive.
*
*
* The following restrictions apply to tags:
*
*
* -
*
* For each resource, each tag key must be unique and each tag key must have one value.
*
*
* -
*
* Maximum number of tags per resource: 50.
*
*
* -
*
* Maximum key length: 128 Unicode characters in UTF-8.
*
*
* -
*
* Maximum value length: 256 Unicode characters in UTF-8.
*
*
* -
*
* Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging
* schema is used across other services and resources, the character restrictions of those services also apply.
*
*
* -
*
* Key prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values
* can have this prefix. If a tag value has aws as its prefix but the key does not, Forecast considers
* it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of
* aws do not count against your tags per resource limit. You cannot edit or delete tag keys with this
* prefix.
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an
* optional value, both of which you define. Tag keys and values are case sensitive.
*
* The following restrictions apply to tags:
*
*
* -
*
* For each resource, each tag key must be unique and each tag key must have one value.
*
*
* -
*
* Maximum number of tags per resource: 50.
*
*
* -
*
* Maximum key length: 128 Unicode characters in UTF-8.
*
*
* -
*
* Maximum value length: 256 Unicode characters in UTF-8.
*
*
* -
*
* Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your
* tagging schema is used across other services and resources, the character restrictions of those services
* also apply.
*
*
* -
*
* Key prefixes cannot include any upper or lowercase combination of aws: or AWS:.
* Values can have this prefix. If a tag value has aws as its prefix but the key does not,
* Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key
* prefix of aws do not count against your tags per resource limit. You cannot edit or delete
* tag keys with this prefix.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateExplainabilityExportRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional
* value, both of which you define. Tag keys and values are case sensitive.
*
*
* The following restrictions apply to tags:
*
*
* -
*
* For each resource, each tag key must be unique and each tag key must have one value.
*
*
* -
*
* Maximum number of tags per resource: 50.
*
*
* -
*
* Maximum key length: 128 Unicode characters in UTF-8.
*
*
* -
*
* Maximum value length: 256 Unicode characters in UTF-8.
*
*
* -
*
* Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging
* schema is used across other services and resources, the character restrictions of those services also apply.
*
*
* -
*
* Key prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values
* can have this prefix. If a tag value has aws as its prefix but the key does not, Forecast considers
* it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of
* aws do not count against your tags per resource limit. You cannot edit or delete tag keys with this
* prefix.
*
*
*
*
* @param tags
* Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an
* optional value, both of which you define. Tag keys and values are case sensitive.
*
* The following restrictions apply to tags:
*
*
* -
*
* For each resource, each tag key must be unique and each tag key must have one value.
*
*
* -
*
* Maximum number of tags per resource: 50.
*
*
* -
*
* Maximum key length: 128 Unicode characters in UTF-8.
*
*
* -
*
* Maximum value length: 256 Unicode characters in UTF-8.
*
*
* -
*
* Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your
* tagging schema is used across other services and resources, the character restrictions of those services
* also apply.
*
*
* -
*
* Key prefixes cannot include any upper or lowercase combination of aws: or AWS:.
* Values can have this prefix. If a tag value has aws as its prefix but the key does not,
* Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key
* prefix of aws do not count against your tags per resource limit. You cannot edit or delete
* tag keys with this prefix.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateExplainabilityExportRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* The format of the exported data, CSV or PARQUET.
*
*
* @param format
* The format of the exported data, CSV or PARQUET.
*/
public void setFormat(String format) {
this.format = format;
}
/**
*
* The format of the exported data, CSV or PARQUET.
*
*
* @return The format of the exported data, CSV or PARQUET.
*/
public String getFormat() {
return this.format;
}
/**
*
* The format of the exported data, CSV or PARQUET.
*
*
* @param format
* The format of the exported data, CSV or PARQUET.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateExplainabilityExportRequest withFormat(String format) {
setFormat(format);
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 (getExplainabilityExportName() != null)
sb.append("ExplainabilityExportName: ").append(getExplainabilityExportName()).append(",");
if (getExplainabilityArn() != null)
sb.append("ExplainabilityArn: ").append(getExplainabilityArn()).append(",");
if (getDestination() != null)
sb.append("Destination: ").append(getDestination()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getFormat() != null)
sb.append("Format: ").append(getFormat());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateExplainabilityExportRequest == false)
return false;
CreateExplainabilityExportRequest other = (CreateExplainabilityExportRequest) obj;
if (other.getExplainabilityExportName() == null ^ this.getExplainabilityExportName() == null)
return false;
if (other.getExplainabilityExportName() != null && other.getExplainabilityExportName().equals(this.getExplainabilityExportName()) == false)
return false;
if (other.getExplainabilityArn() == null ^ this.getExplainabilityArn() == null)
return false;
if (other.getExplainabilityArn() != null && other.getExplainabilityArn().equals(this.getExplainabilityArn()) == false)
return false;
if (other.getDestination() == null ^ this.getDestination() == null)
return false;
if (other.getDestination() != null && other.getDestination().equals(this.getDestination()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getFormat() == null ^ this.getFormat() == null)
return false;
if (other.getFormat() != null && other.getFormat().equals(this.getFormat()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getExplainabilityExportName() == null) ? 0 : getExplainabilityExportName().hashCode());
hashCode = prime * hashCode + ((getExplainabilityArn() == null) ? 0 : getExplainabilityArn().hashCode());
hashCode = prime * hashCode + ((getDestination() == null) ? 0 : getDestination().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getFormat() == null) ? 0 : getFormat().hashCode());
return hashCode;
}
@Override
public CreateExplainabilityExportRequest clone() {
return (CreateExplainabilityExportRequest) super.clone();
}
}