Segment (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudwatchevidently.model.Segment

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Segment
extends Object
implements Serializable, Cloneable, StructuredPojo
```
This structure contains information about one audience segment. You can use segments in your experiments and launches to narrow the user sessions used for experiment or launch to only the user sessions that match one or more criteria.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Segment()

Constructors
Constructor and Description
`Segment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Segment`	`addTagsEntry(String key, String value)` Add a single Tags entry
`Segment`	`clearTagsEntries()` Removes all the entries added into Tags.
`Segment`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The ARN of the segment.
`Date`	`getCreatedTime()` The date and time that this segment was created.
`String`	`getDescription()` The customer-created description for this segment.
`Long`	`getExperimentCount()` The number of experiments that this segment is used in.
`Date`	`getLastUpdatedTime()` The date and time that this segment was most recently updated.
`Long`	`getLaunchCount()` The number of launches that this segment is used in.
`String`	`getName()` The name of the segment.
`String`	`getPattern()` The pattern that defines the attributes to use to evalute whether a user session will be in the segment.
`Map<String,String>`	`getTags()` The list of tag keys and values associated with this launch.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The ARN of the segment.
`void`	`setCreatedTime(Date createdTime)` The date and time that this segment was created.
`void`	`setDescription(String description)` The customer-created description for this segment.
`void`	`setExperimentCount(Long experimentCount)` The number of experiments that this segment is used in.
`void`	`setLastUpdatedTime(Date lastUpdatedTime)` The date and time that this segment was most recently updated.
`void`	`setLaunchCount(Long launchCount)` The number of launches that this segment is used in.
`void`	`setName(String name)` The name of the segment.
`void`	`setPattern(String pattern)` The pattern that defines the attributes to use to evalute whether a user session will be in the segment.
`void`	`setTags(Map<String,String> tags)` The list of tag keys and values associated with this launch.
`String`	`toString()` Returns a string representation of this object.
`Segment`	`withArn(String arn)` The ARN of the segment.
`Segment`	`withCreatedTime(Date createdTime)` The date and time that this segment was created.
`Segment`	`withDescription(String description)` The customer-created description for this segment.
`Segment`	`withExperimentCount(Long experimentCount)` The number of experiments that this segment is used in.
`Segment`	`withLastUpdatedTime(Date lastUpdatedTime)` The date and time that this segment was most recently updated.
`Segment`	`withLaunchCount(Long launchCount)` The number of launches that this segment is used in.
`Segment`	`withName(String name)` The name of the segment.
`Segment`	`withPattern(String pattern)` The pattern that defines the attributes to use to evalute whether a user session will be in the segment.
`Segment`	`withTags(Map<String,String> tags)` The list of tag keys and values associated with this launch.

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

- Constructor Detail
  - Segment
```
public Segment()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The ARN of the segment.
    
    Parameters:
    
    arn - The ARN of the segment.
  - getArn
```
public String getArn()
```
    The ARN of the segment.
    
    Returns:
    
    The ARN of the segment.
  - withArn
```
public Segment withArn(String arn)
```
    The ARN of the segment.
    
    Parameters:
    
    arn - The ARN of the segment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedTime
```
public void setCreatedTime(Date createdTime)
```
    The date and time that this segment was created.
    
    Parameters:
    
    createdTime - The date and time that this segment was created.
  - getCreatedTime
```
public Date getCreatedTime()
```
    The date and time that this segment was created.
    
    Returns:
    
    The date and time that this segment was created.
  - withCreatedTime
```
public Segment withCreatedTime(Date createdTime)
```
    The date and time that this segment was created.
    
    Parameters:
    
    createdTime - The date and time that this segment was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The customer-created description for this segment.
    
    Parameters:
    
    description - The customer-created description for this segment.
  - getDescription
```
public String getDescription()
```
    The customer-created description for this segment.
    
    Returns:
    
    The customer-created description for this segment.
  - withDescription
```
public Segment withDescription(String description)
```
    The customer-created description for this segment.
    
    Parameters:
    
    description - The customer-created description for this segment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExperimentCount
```
public void setExperimentCount(Long experimentCount)
```
    The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.
    
    Parameters:
    
    experimentCount - The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.
  - getExperimentCount
```
public Long getExperimentCount()
```
    The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.
    
    Returns:
    
    The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.
  - withExperimentCount
```
public Segment withExperimentCount(Long experimentCount)
```
    The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.
    
    Parameters:
    
    experimentCount - The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedTime
```
public void setLastUpdatedTime(Date lastUpdatedTime)
```
    The date and time that this segment was most recently updated.
    
    Parameters:
    
    lastUpdatedTime - The date and time that this segment was most recently updated.
  - getLastUpdatedTime
```
public Date getLastUpdatedTime()
```
    The date and time that this segment was most recently updated.
    
    Returns:
    
    The date and time that this segment was most recently updated.
  - withLastUpdatedTime
```
public Segment withLastUpdatedTime(Date lastUpdatedTime)
```
    The date and time that this segment was most recently updated.
    
    Parameters:
    
    lastUpdatedTime - The date and time that this segment was most recently updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLaunchCount
```
public void setLaunchCount(Long launchCount)
```
    The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.
    
    Parameters:
    
    launchCount - The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.
  - getLaunchCount
```
public Long getLaunchCount()
```
    The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.
    
    Returns:
    
    The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.
  - withLaunchCount
```
public Segment withLaunchCount(Long launchCount)
```
    The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.
    
    Parameters:
    
    launchCount - The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.
    
    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 Segment 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.
  - setPattern
```
public void setPattern(String pattern)
```
    The pattern that defines the attributes to use to evalute whether a user session will be in the segment. For more information about the pattern syntax, see Segment rule pattern syntax.
    
    This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Parameters:
    
    pattern - The pattern that defines the attributes to use to evalute whether a user session will be in the segment. For more information about the pattern syntax, see Segment rule pattern syntax.
  - getPattern
```
public String getPattern()
```
    The pattern that defines the attributes to use to evalute whether a user session will be in the segment. For more information about the pattern syntax, see Segment rule pattern syntax.
    
    This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
    
    Returns:
    
    The pattern that defines the attributes to use to evalute whether a user session will be in the segment. For more information about the pattern syntax, see Segment rule pattern syntax.
  - withPattern
```
public Segment withPattern(String pattern)
```
    The pattern that defines the attributes to use to evalute whether a user session will be in the segment. For more information about the pattern syntax, see Segment rule pattern syntax.
    
    This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Parameters:
    
    pattern - The pattern that defines the attributes to use to evalute whether a user session will be in the segment. For more information about the pattern syntax, see Segment rule pattern syntax.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The list of tag keys and values associated with this launch.
    
    Returns:
    
    The list of tag keys and values associated with this launch.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The list of tag keys and values associated with this launch.
    
    Parameters:
    
    tags - The list of tag keys and values associated with this launch.
  - withTags
```
public Segment withTags(Map<String,String> tags)
```
    The list of tag keys and values associated with this launch.
    
    Parameters:
    
    tags - The list of tag keys and values associated with this launch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public Segment addTagsEntry(String key,
                            String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public Segment 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 Segment 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 Segment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Segment

Method Detail

setArn

getArn

withArn

setCreatedTime

getCreatedTime

withCreatedTime

setDescription

getDescription

withDescription

setExperimentCount

getExperimentCount

withExperimentCount

setLastUpdatedTime

getLastUpdatedTime

withLastUpdatedTime

setLaunchCount

getLaunchCount

withLaunchCount

setName

getName

withName

setPattern

getPattern

withPattern

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone

marshall