Package com.oracle.bmc.loganalytics.model

Class ModuleCommandDescriptor

java.lang.Object

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

com.oracle.bmc.loganalytics.model.AbstractCommandDescriptor

com.oracle.bmc.loganalytics.model.ModuleCommandDescriptor

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200601")
public final class ModuleCommandDescriptor
extends AbstractCommandDescriptor

Command descriptor for querylanguage MODULE command.
Note: Objects should always be created or deserialized using the ModuleCommandDescriptor.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 ModuleCommandDescriptor.Builder, which maintain a set of all explicitly set fields called ModuleCommandDescriptor.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	ModuleCommandDescriptor.Builder

Nested classes/interfaces inherited from class com.oracle.bmc.loganalytics.model.AbstractCommandDescriptor

AbstractCommandDescriptor.Name

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
ModuleCommandDescriptor(String displayQueryString, String internalQueryString, String category, List<AbstractField> referencedFields, List<AbstractField> declaredFields, Boolean isHidden, String description, String example, List<PropertyDefinition> properties, List<VariableDefinition> arguments)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static ModuleCommandDescriptor.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<VariableDefinition>	getArguments()	Optional list of arguments used in the macro.
String	getDescription()	Description of the macro.
String	getExample()	Description of the macro.
List<PropertyDefinition>	getProperties()	Optional list of properties for the macro.
int	hashCode()
ModuleCommandDescriptor.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.loganalytics.model.AbstractCommandDescriptor

getCategory, getDeclaredFields, getDisplayQueryString, getInternalQueryString, getIsHidden, getReferencedFields

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

ModuleCommandDescriptor

@Deprecated
public ModuleCommandDescriptor(String displayQueryString,
                               String internalQueryString,
                               String category,
                               List<AbstractField> referencedFields,
                               List<AbstractField> declaredFields,
                               Boolean isHidden,
                               String description,
                               String example,
                               List<PropertyDefinition> properties,
                               List<VariableDefinition> arguments)

Deprecated.

Method Detail

builder

public static ModuleCommandDescriptor.Builder builder()

Create a new builder.

toBuilder

public ModuleCommandDescriptor.Builder toBuilder()

getDescription

public String getDescription()

Description of the macro.

Returns:

the value

getExample

public String getExample()

Description of the macro.

Returns:

the value

getProperties

public List<PropertyDefinition> getProperties()

Optional list of properties for the macro.

Returns:

the value

getArguments

public List<VariableDefinition> getArguments()

Optional list of arguments used in the macro.

Returns:

the value

toString

public String toString()

Overrides:

toString in class AbstractCommandDescriptor

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class AbstractCommandDescriptor

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractCommandDescriptor

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractCommandDescriptor