Package com.oracle.bmc.loganalytics.model

Class VariableDefinition

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.loganalytics.model.VariableDefinition

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200601")
public final class VariableDefinition
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Defines a variable used in a macro or the initization section of a query.
Note: Objects should always be created or deserialized using the VariableDefinition.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the VariableDefinition.Builder, which maintain a set of all explicitly set fields called VariableDefinition.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VariableDefinition.Builder
static class	VariableDefinition.Type	Type of the variable to show the user.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
VariableDefinition(String name, String description, VariableDefinition.Type type, String defaultValue, List<PropertyDefinition> properties)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static VariableDefinition.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getDefaultValue()	Default value of the variable is not already set.
String	getDescription()	Descripion of the variable to show the user.
String	getName()	Name of the variable preceded by a $.
List<PropertyDefinition>	getProperties()	Optional list of properties for the variable.
VariableDefinition.Type	getType()	Type of the variable to show the user.
int	hashCode()
VariableDefinition.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableDefinition

@Deprecated
@ConstructorProperties({"name","description","type","defaultValue","properties"})
public VariableDefinition(String name,
                          String description,
                          VariableDefinition.Type type,
                          String defaultValue,
                          List<PropertyDefinition> properties)

Deprecated.

Method Detail

builder

public static VariableDefinition.Builder builder()

Create a new builder.

toBuilder

public VariableDefinition.Builder toBuilder()

getName

public String getName()

Name of the variable preceded by a $.

Returns:

the value

getDescription

public String getDescription()

Descripion of the variable to show the user.

Returns:

the value

getType

public VariableDefinition.Type getType()

Type of the variable to show the user.

Returns:

the value

getDefaultValue

public String getDefaultValue()

Default value of the variable is not already set.

Returns:

the value

getProperties

public List<PropertyDefinition> getProperties()

Optional list of properties for the variable.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel