com.amazonaws.services.quicksight.model.SameSheetTargetVisualConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-quicksight 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.quicksight.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The configuration of the same-sheet target visuals that you want to be filtered.
*
*
* This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SameSheetTargetVisualConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* A list of the target visual IDs that are located in the same sheet of the analysis.
*
*/
private java.util.List targetVisuals;
/**
*
* The options that choose the target visual in the same sheet.
*
*
* Valid values are defined as follows:
*
*
* -
*
* ALL_VISUALS: Applies the filter operation to all visuals in the same sheet.
*
*
*
*/
private String targetVisualOptions;
/**
*
* A list of the target visual IDs that are located in the same sheet of the analysis.
*
*
* @return A list of the target visual IDs that are located in the same sheet of the analysis.
*/
public java.util.List getTargetVisuals() {
return targetVisuals;
}
/**
*
* A list of the target visual IDs that are located in the same sheet of the analysis.
*
*
* @param targetVisuals
* A list of the target visual IDs that are located in the same sheet of the analysis.
*/
public void setTargetVisuals(java.util.Collection targetVisuals) {
if (targetVisuals == null) {
this.targetVisuals = null;
return;
}
this.targetVisuals = new java.util.ArrayList(targetVisuals);
}
/**
*
* A list of the target visual IDs that are located in the same sheet of the analysis.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTargetVisuals(java.util.Collection)} or {@link #withTargetVisuals(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param targetVisuals
* A list of the target visual IDs that are located in the same sheet of the analysis.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SameSheetTargetVisualConfiguration withTargetVisuals(String... targetVisuals) {
if (this.targetVisuals == null) {
setTargetVisuals(new java.util.ArrayList(targetVisuals.length));
}
for (String ele : targetVisuals) {
this.targetVisuals.add(ele);
}
return this;
}
/**
*
* A list of the target visual IDs that are located in the same sheet of the analysis.
*
*
* @param targetVisuals
* A list of the target visual IDs that are located in the same sheet of the analysis.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SameSheetTargetVisualConfiguration withTargetVisuals(java.util.Collection targetVisuals) {
setTargetVisuals(targetVisuals);
return this;
}
/**
*
* The options that choose the target visual in the same sheet.
*
*
* Valid values are defined as follows:
*
*
* -
*
* ALL_VISUALS: Applies the filter operation to all visuals in the same sheet.
*
*
*
*
* @param targetVisualOptions
* The options that choose the target visual in the same sheet.
*
* Valid values are defined as follows:
*
*
* -
*
* ALL_VISUALS: Applies the filter operation to all visuals in the same sheet.
*
*
* @see TargetVisualOptions
*/
public void setTargetVisualOptions(String targetVisualOptions) {
this.targetVisualOptions = targetVisualOptions;
}
/**
*
* The options that choose the target visual in the same sheet.
*
*
* Valid values are defined as follows:
*
*
* -
*
* ALL_VISUALS: Applies the filter operation to all visuals in the same sheet.
*
*
*
*
* @return The options that choose the target visual in the same sheet.
*
* Valid values are defined as follows:
*
*
* -
*
* ALL_VISUALS: Applies the filter operation to all visuals in the same sheet.
*
*
* @see TargetVisualOptions
*/
public String getTargetVisualOptions() {
return this.targetVisualOptions;
}
/**
*
* The options that choose the target visual in the same sheet.
*
*
* Valid values are defined as follows:
*
*
* -
*
* ALL_VISUALS: Applies the filter operation to all visuals in the same sheet.
*
*
*
*
* @param targetVisualOptions
* The options that choose the target visual in the same sheet.
*
* Valid values are defined as follows:
*
*
* -
*
* ALL_VISUALS: Applies the filter operation to all visuals in the same sheet.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see TargetVisualOptions
*/
public SameSheetTargetVisualConfiguration withTargetVisualOptions(String targetVisualOptions) {
setTargetVisualOptions(targetVisualOptions);
return this;
}
/**
*
* The options that choose the target visual in the same sheet.
*
*
* Valid values are defined as follows:
*
*
* -
*
* ALL_VISUALS: Applies the filter operation to all visuals in the same sheet.
*
*
*
*
* @param targetVisualOptions
* The options that choose the target visual in the same sheet.
*
* Valid values are defined as follows:
*
*
* -
*
* ALL_VISUALS: Applies the filter operation to all visuals in the same sheet.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see TargetVisualOptions
*/
public SameSheetTargetVisualConfiguration withTargetVisualOptions(TargetVisualOptions targetVisualOptions) {
this.targetVisualOptions = targetVisualOptions.toString();
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 (getTargetVisuals() != null)
sb.append("TargetVisuals: ").append(getTargetVisuals()).append(",");
if (getTargetVisualOptions() != null)
sb.append("TargetVisualOptions: ").append(getTargetVisualOptions());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SameSheetTargetVisualConfiguration == false)
return false;
SameSheetTargetVisualConfiguration other = (SameSheetTargetVisualConfiguration) obj;
if (other.getTargetVisuals() == null ^ this.getTargetVisuals() == null)
return false;
if (other.getTargetVisuals() != null && other.getTargetVisuals().equals(this.getTargetVisuals()) == false)
return false;
if (other.getTargetVisualOptions() == null ^ this.getTargetVisualOptions() == null)
return false;
if (other.getTargetVisualOptions() != null && other.getTargetVisualOptions().equals(this.getTargetVisualOptions()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTargetVisuals() == null) ? 0 : getTargetVisuals().hashCode());
hashCode = prime * hashCode + ((getTargetVisualOptions() == null) ? 0 : getTargetVisualOptions().hashCode());
return hashCode;
}
@Override
public SameSheetTargetVisualConfiguration clone() {
try {
return (SameSheetTargetVisualConfiguration) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.quicksight.model.transform.SameSheetTargetVisualConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}