/* * Copyright 2018-2023 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.pinpoint.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a * Dimensions object or a SegmentGroups object, but not both. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class WriteSegmentRequest implements Serializable, Cloneable, StructuredPojo { /** *

* The criteria that define the dimensions for the segment. *

*/ private SegmentDimensions dimensions; /** *

* The name of the segment. *

*/ private String name; /** *

* The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. * A segment group can consist of zero or more base segments. Your request can include only one segment group. *

*/ private SegmentGroupList segmentGroups; /** * *

* As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not * processed and an error code is not returned. To manage tags we recommend using either Tags in the API * Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK. *

* *

* (Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each * tag consists of a required tag key and an associated tag value. *

*/ private java.util.Map tags; /** *

* The criteria that define the dimensions for the segment. *

* * @param dimensions * The criteria that define the dimensions for the segment. */ public void setDimensions(SegmentDimensions dimensions) { this.dimensions = dimensions; } /** *

* The criteria that define the dimensions for the segment. *

* * @return The criteria that define the dimensions for the segment. */ public SegmentDimensions getDimensions() { return this.dimensions; } /** *

* The criteria that define the dimensions for the segment. *

* * @param dimensions * The criteria that define the dimensions for the segment. * @return Returns a reference to this object so that method calls can be chained together. */ public WriteSegmentRequest withDimensions(SegmentDimensions dimensions) { setDimensions(dimensions); return this; } /** *

* The name of the segment. *

* * @param name * The name of the segment. */ public void setName(String name) { this.name = name; } /** *

* The name of the segment. *

* * @return The name of the segment. */ public String getName() { return this.name; } /** *

* The name of the segment. *

* * @param name * The name of the segment. * @return Returns a reference to this object so that method calls can be chained together. */ public WriteSegmentRequest withName(String name) { setName(name); return this; } /** *

* * @param segmentGroups * The segment group to use and the dimensions to apply to the group's base segments in order to build the * segment. A segment group can consist of zero or more base segments. Your request can include only one * segment group. */ public void setSegmentGroups(SegmentGroupList segmentGroups) { this.segmentGroups = segmentGroups; } /** *

* * @return The segment group to use and the dimensions to apply to the group's base segments in order to build the * segment. A segment group can consist of zero or more base segments. Your request can include only one * segment group. */ public SegmentGroupList getSegmentGroups() { return this.segmentGroups; } /** *

* * @param segmentGroups * The segment group to use and the dimensions to apply to the group's base segments in order to build the * segment. A segment group can consist of zero or more base segments. Your request can include only one * segment group. * @return Returns a reference to this object so that method calls can be chained together. */ public WriteSegmentRequest withSegmentGroups(SegmentGroupList segmentGroups) { setSegmentGroups(segmentGroups); return this; } /** * *

* *

* (Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each * tag consists of a required tag key and an associated tag value. *

* * @return As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags * is not processed and an error code is not returned. To manage tags we recommend using either Tags in the * API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

*/ public java.util.Map getTags() { return tags; } /** * *

* *

* (Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each * tag consists of a required tag key and an associated tag value. *

* * @param tags * As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags * is not processed and an error code is not returned. To manage tags we recommend using either Tags in the * API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

*/ public void setTags(java.util.Map tags) { this.tags = tags; } /** * *

* *

* (Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each * tag consists of a required tag key and an associated tag value. *

* @return Returns a reference to this object so that method calls can be chained together. */ public WriteSegmentRequest withTags(java.util.Map tags) { setTags(tags); return this; } /** * Add a single Tags entry * * @see WriteSegmentRequest#withTags * @returns a reference to this object so that method calls can be chained together. */ public WriteSegmentRequest addTagsEntry(String key, String value) { if (null == this.tags) { this.tags = new java.util.HashMap(); } if (this.tags.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.tags.put(key, value); return this; } /** * Removes all the entries added into Tags. * * @return Returns a reference to this object so that method calls can be chained together. */ public WriteSegmentRequest clearTagsEntries() { this.tags = null; 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 (getDimensions() != null) sb.append("Dimensions: ").append(getDimensions()).append(","); if (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getSegmentGroups() != null) sb.append("SegmentGroups: ").append(getSegmentGroups()).append(","); if (getTags() != null) sb.append("Tags: ").append(getTags()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof WriteSegmentRequest == false) return false; WriteSegmentRequest other = (WriteSegmentRequest) obj; if (other.getDimensions() == null ^ this.getDimensions() == null) return false; if (other.getDimensions() != null && other.getDimensions().equals(this.getDimensions()) == 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.getSegmentGroups() == null ^ this.getSegmentGroups() == null) return false; if (other.getSegmentGroups() != null && other.getSegmentGroups().equals(this.getSegmentGroups()) == false) return false; if (other.getTags() == null ^ this.getTags() == null) return false; if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getDimensions() == null) ? 0 : getDimensions().hashCode()); hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getSegmentGroups() == null) ? 0 : getSegmentGroups().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); return hashCode; } @Override public WriteSegmentRequest clone() { try { return (WriteSegmentRequest) 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.pinpoint.model.transform.WriteSegmentRequestMarshaller.getInstance().marshall(this, protocolMarshaller); } }