Package com.launchdarkly.api.model

Class PatchSegmentInstruction

java.lang.Object

com.launchdarkly.api.model.PatchSegmentInstruction

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-11-16T23:57:26.096741Z[Etc/UTC]")
public class PatchSegmentInstruction
extends java.lang.Object

PatchSegmentInstruction

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PatchSegmentInstruction.CustomTypeAdapterFactory
static class	PatchSegmentInstruction.KindEnum	The type of change to make to the user's removal date from this segment
static class	PatchSegmentInstruction.TargetTypeEnum	The segment's target type

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.HashSet<java.lang.String>	openapiFields
static java.util.HashSet<java.lang.String>	openapiRequiredFields
static java.lang.String	SERIALIZED_NAME_KIND
static java.lang.String	SERIALIZED_NAME_TARGET_TYPE
static java.lang.String	SERIALIZED_NAME_USER_KEY
static java.lang.String	SERIALIZED_NAME_VALUE
static java.lang.String	SERIALIZED_NAME_VERSION

Constructor Summary

Constructors

Constructor	Description
PatchSegmentInstruction()

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
static PatchSegmentInstruction	fromJson(java.lang.String jsonString)	Create an instance of PatchSegmentInstruction given an JSON string
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()	Return the additional (undeclared) property.
java.lang.Object	getAdditionalProperty(java.lang.String key)	Return the additional (undeclared) property with the specified name.
PatchSegmentInstruction.KindEnum	getKind()	The type of change to make to the user's removal date from this segment
PatchSegmentInstruction.TargetTypeEnum	getTargetType()	The segment's target type
java.lang.String	getUserKey()	A unique key used to represent the user
java.lang.Integer	getValue()	The time, in Unix milliseconds, when the user should be removed from this segment.
java.lang.Integer	getVersion()	The version of the segment to update.
int	hashCode()
PatchSegmentInstruction	kind(PatchSegmentInstruction.KindEnum kind)
PatchSegmentInstruction	putAdditionalProperty(java.lang.String key, java.lang.Object value)	Set the additional (undeclared) property with the specified name and value.
void	setKind(PatchSegmentInstruction.KindEnum kind)
void	setTargetType(PatchSegmentInstruction.TargetTypeEnum targetType)
void	setUserKey(java.lang.String userKey)
void	setValue(java.lang.Integer value)
void	setVersion(java.lang.Integer version)
PatchSegmentInstruction	targetType(PatchSegmentInstruction.TargetTypeEnum targetType)
java.lang.String	toJson()	Convert an instance of PatchSegmentInstruction to an JSON string
java.lang.String	toString()
PatchSegmentInstruction	userKey(java.lang.String userKey)
static void	validateJsonObject(com.google.gson.JsonObject jsonObj)	Validates the JSON Object and throws an exception if issues found
PatchSegmentInstruction	value(java.lang.Integer value)
PatchSegmentInstruction	version(java.lang.Integer version)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_KIND

public static final java.lang.String SERIALIZED_NAME_KIND

See Also:

Constant Field Values

SERIALIZED_NAME_USER_KEY

public static final java.lang.String SERIALIZED_NAME_USER_KEY

See Also:

Constant Field Values

SERIALIZED_NAME_TARGET_TYPE

public static final java.lang.String SERIALIZED_NAME_TARGET_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_VALUE

public static final java.lang.String SERIALIZED_NAME_VALUE

See Also:

Constant Field Values

SERIALIZED_NAME_VERSION

public static final java.lang.String SERIALIZED_NAME_VERSION

See Also:

Constant Field Values

openapiFields

public static java.util.HashSet<java.lang.String> openapiFields

openapiRequiredFields

public static java.util.HashSet<java.lang.String> openapiRequiredFields

Constructor Detail

PatchSegmentInstruction

public PatchSegmentInstruction()

Method Detail

kind

public PatchSegmentInstruction kind(PatchSegmentInstruction.KindEnum kind)

getKind

@Nonnull
public PatchSegmentInstruction.KindEnum getKind()

The type of change to make to the user's removal date from this segment

Returns:

kind

setKind

public void setKind(PatchSegmentInstruction.KindEnum kind)

userKey

public PatchSegmentInstruction userKey(java.lang.String userKey)

getUserKey

@Nonnull
public java.lang.String getUserKey()

A unique key used to represent the user

Returns:

userKey

setUserKey

public void setUserKey(java.lang.String userKey)

targetType

public PatchSegmentInstruction targetType(PatchSegmentInstruction.TargetTypeEnum targetType)

getTargetType

@Nonnull
public PatchSegmentInstruction.TargetTypeEnum getTargetType()

The segment's target type

Returns:

targetType

setTargetType

public void setTargetType(PatchSegmentInstruction.TargetTypeEnum targetType)

value

public PatchSegmentInstruction value(java.lang.Integer value)

getValue

@Nullable
public java.lang.Integer getValue()

The time, in Unix milliseconds, when the user should be removed from this segment. Required if <code>kind</code> is <code>addExpireUserTargetDate</code> or <code>updateExpireUserTargetDate</code>.

Returns:

value

setValue

public void setValue(java.lang.Integer value)

version

public PatchSegmentInstruction version(java.lang.Integer version)

getVersion

@Nullable
public java.lang.Integer getVersion()

The version of the segment to update. Required if <code>kind</code> is <code>updateExpireUserTargetDate</code>.

Returns:

version

setVersion

public void setVersion(java.lang.Integer version)

putAdditionalProperty

public PatchSegmentInstruction putAdditionalProperty(java.lang.String key,
                                                     java.lang.Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

getAdditionalProperties

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()

Return the additional (undeclared) property.

getAdditionalProperty

public java.lang.Object getAdditionalProperty(java.lang.String key)

Return the additional (undeclared) property with the specified name.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

validateJsonObject

public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws java.io.IOException

Validates the JSON Object and throws an exception if issues found

Parameters:

jsonObj - JSON Object

Throws:

java.io.IOException - if the JSON Object is invalid with respect to PatchSegmentInstruction

fromJson

public static PatchSegmentInstruction fromJson(java.lang.String jsonString)
                                        throws java.io.IOException

Create an instance of PatchSegmentInstruction given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of PatchSegmentInstruction

Throws:

java.io.IOException - if the JSON string is invalid with respect to PatchSegmentInstruction

toJson

public java.lang.String toJson()

Convert an instance of PatchSegmentInstruction to an JSON string

Returns:

JSON string