Package io.camunda.client.protocol.rest

Class ClusterVariableSearchResult

java.lang.Object

io.camunda.client.protocol.rest.ClusterVariableSearchResult

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.23.0")
public class ClusterVariableSearchResult
extends Object

ClusterVariableSearchResult

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_IS_TRUNCATED
static final String	JSON_PROPERTY_KIND
static final String	JSON_PROPERTY_METADATA
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_SCOPE
static final String	JSON_PROPERTY_TENANT_ID
static final String	JSON_PROPERTY_VALUE

Constructor Summary

Constructors

Constructor	Description
ClusterVariableSearchResult()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Boolean	getIsTruncated()	Whether the value is truncated or not.
ClusterVariableKindEnum	getKind()	Get kind
Map<String,Object>	getMetadata()	A generic key-value metadata bag attached to the cluster variable.
String	getName()	The name of the cluster variable.
ClusterVariableScopeEnum	getScope()	Get scope
String	getTenantId()	Only provided if the cluster variable scope is TENANT.
String	getValue()	Value of this cluster variable.
int	hashCode()
ClusterVariableSearchResult	isTruncated(Boolean isTruncated)
ClusterVariableSearchResult	kind(ClusterVariableKindEnum kind)
ClusterVariableSearchResult	metadata(Map<String,Object> metadata)
ClusterVariableSearchResult	name(String name)
ClusterVariableSearchResult	putMetadataItem(String key, Object metadataItem)
ClusterVariableSearchResult	scope(ClusterVariableScopeEnum scope)
void	setIsTruncated(Boolean isTruncated)
void	setKind(ClusterVariableKindEnum kind)
void	setMetadata(Map<String,Object> metadata)
void	setName(String name)
void	setScope(ClusterVariableScopeEnum scope)
void	setTenantId(String tenantId)
void	setValue(String value)
ClusterVariableSearchResult	tenantId(String tenantId)
String	toString()
ClusterVariableSearchResult	value(String value)

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_SCOPE

public static final String JSON_PROPERTY_SCOPE

See Also:

• Constant Field Values

JSON_PROPERTY_TENANT_ID

public static final String JSON_PROPERTY_TENANT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_METADATA

public static final String JSON_PROPERTY_METADATA

See Also:

• Constant Field Values

JSON_PROPERTY_KIND

public static final String JSON_PROPERTY_KIND

See Also:

• Constant Field Values

JSON_PROPERTY_VALUE

public static final String JSON_PROPERTY_VALUE

See Also:

• Constant Field Values

JSON_PROPERTY_IS_TRUNCATED

public static final String JSON_PROPERTY_IS_TRUNCATED

See Also:

• Constant Field Values

Constructor Details

ClusterVariableSearchResult

public ClusterVariableSearchResult()

Method Details

name

public ClusterVariableSearchResult name(@Nonnull
 String name)

getName

@Nonnull
public String getName()

The name of the cluster variable. Unique within its scope (global or tenant-specific).

Returns:

name

setName

public void setName(@Nonnull
 String name)

scope

public ClusterVariableSearchResult scope(@Nonnull
 ClusterVariableScopeEnum scope)

getScope

@Nonnull
public ClusterVariableScopeEnum getScope()

Get scope

Returns:

scope

setScope

public void setScope(@Nonnull
 ClusterVariableScopeEnum scope)

tenantId

public ClusterVariableSearchResult tenantId(@Nullable
 String tenantId)

getTenantId

@Nullable
public String getTenantId()

Only provided if the cluster variable scope is TENANT. Null for global scope variables.

Returns:

tenantId

setTenantId

public void setTenantId(@Nullable
 String tenantId)

metadata

public ClusterVariableSearchResult metadata(@Nonnull
 Map<String,Object> metadata)

putMetadataItem

public ClusterVariableSearchResult putMetadataItem(String key,
 Object metadataItem)

getMetadata

@Nonnull
public Map<String,Object> getMetadata()

A generic key-value metadata bag attached to the cluster variable. Values are strings or numbers.

Returns:

metadata

setMetadata

public void setMetadata(@Nonnull
 Map<String,Object> metadata)

kind

public ClusterVariableSearchResult kind(@Nonnull
 ClusterVariableKindEnum kind)

getKind

@Nonnull
public ClusterVariableKindEnum getKind()

Get kind

Returns:

kind

setKind

public void setKind(@Nonnull
 ClusterVariableKindEnum kind)

value

public ClusterVariableSearchResult value(@Nonnull
 String value)

getValue

@Nonnull
public String getValue()

Value of this cluster variable. Can be truncated.

Returns:

value

setValue

public void setValue(@Nonnull
 String value)

isTruncated

public ClusterVariableSearchResult isTruncated(@Nonnull
 Boolean isTruncated)

getIsTruncated

@Nonnull
public Boolean getIsTruncated()

Whether the value is truncated or not.

Returns:

isTruncated

setIsTruncated

public void setIsTruncated(@Nonnull
 Boolean isTruncated)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object