WriteSegmentRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pinpoint.model.WriteSegmentRequest

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class WriteSegmentRequest
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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 Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WriteSegmentRequest()

Constructors
Constructor and Description
`WriteSegmentRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WriteSegmentRequest`	`addTagsEntry(String key, String value)` Add a single Tags entry
`WriteSegmentRequest`	`clearTagsEntries()` Removes all the entries added into Tags.
`WriteSegmentRequest`	`clone()`
`boolean`	`equals(Object obj)`
`SegmentDimensions`	`getDimensions()` The criteria that define the dimensions for the segment.
`String`	`getName()` The name of the segment.
`SegmentGroupList`	`getSegmentGroups()` The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.
`Map<String,String>`	`getTags()`
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDimensions(SegmentDimensions dimensions)` The criteria that define the dimensions for the segment.
`void`	`setName(String name)` The name of the segment.
`void`	`setSegmentGroups(SegmentGroupList segmentGroups)` The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.
`void`	`setTags(Map<String,String> tags)`
`String`	`toString()` Returns a string representation of this object.
`WriteSegmentRequest`	`withDimensions(SegmentDimensions dimensions)` The criteria that define the dimensions for the segment.
`WriteSegmentRequest`	`withName(String name)` The name of the segment.
`WriteSegmentRequest`	`withSegmentGroups(SegmentGroupList segmentGroups)` The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.
`WriteSegmentRequest`	`withTags(Map<String,String> tags)`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - WriteSegmentRequest
```
public WriteSegmentRequest()
```
- Method Detail
  - setDimensions
```
public void setDimensions(SegmentDimensions dimensions)
```
    The criteria that define the dimensions for the segment.
    
    Parameters:
    
    dimensions - The criteria that define the dimensions for the segment.
  - getDimensions
```
public SegmentDimensions getDimensions()
```
    The criteria that define the dimensions for the segment.
    
    Returns:
    
    The criteria that define the dimensions for the segment.
  - withDimensions
```
public WriteSegmentRequest withDimensions(SegmentDimensions dimensions)
```
    The criteria that define the dimensions for the segment.
    
    Parameters:
    
    dimensions - The criteria that define the dimensions for the segment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the segment.
    
    Parameters:
    
    name - The name of the segment.
  - getName
```
public String getName()
```
    The name of the segment.
    
    Returns:
    
    The name of the segment.
  - withName
```
public WriteSegmentRequest withName(String name)
```
    The name of the segment.
    
    Parameters:
    
    name - The name of the segment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSegmentGroups
```
public void setSegmentGroups(SegmentGroupList 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.
    
    Parameters:
    
    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.
  - getSegmentGroups
```
public SegmentGroupList getSegmentGroups()
```
    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.
    
    Returns:
    
    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.
  - withSegmentGroups
```
public WriteSegmentRequest withSegmentGroups(SegmentGroupList 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    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.
    
    Returns:
    
    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.
  - setTags
```
public void setTags(Map<String,String> 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.
    
    (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.
    
    Parameters:
    
    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.
  - withTags
```
public WriteSegmentRequest withTags(Map<String,String> 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.
    
    (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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public WriteSegmentRequest addTagsEntry(String key,
                                        String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public WriteSegmentRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public WriteSegmentRequest clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class WriteSegmentRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WriteSegmentRequest

Method Detail

setDimensions

getDimensions

withDimensions

setName

getName

withName

setSegmentGroups

getSegmentGroups

withSegmentGroups

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone

marshall