Package com.oracle.bmc.datascience.model

Class ConfigurationPropertySchema

java.lang.Object

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

com.oracle.bmc.datascience.model.ConfigurationPropertySchema

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

Schema for single configuration property
Note: Objects should always be created or deserialized using the ConfigurationPropertySchema.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 ConfigurationPropertySchema.Builder, which maintain a set of all explicitly set fields called ConfigurationPropertySchema.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	ConfigurationPropertySchema.Builder
static class	ConfigurationPropertySchema.ValueType	Type of value

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
ConfigurationPropertySchema(String keyName, ConfigurationPropertySchema.ValueType valueType, String description, Boolean isMandatory, String defaultValue, String validationRegexp, String sampleValue)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static ConfigurationPropertySchema.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getDefaultValue()	The default value for the optional configuration property (it must not be specified for mandatory configuration properties)
String	getDescription()	Description of this configuration property
Boolean	getIsMandatory()	If the value is true this configuration property is mandatory and visa versa.
String	getKeyName()	Name of key (parameter name)
String	getSampleValue()	Sample property value (it must match validationRegexp if it is specified)
String	getValidationRegexp()	A regular expression will be used for the validation of property value.
ConfigurationPropertySchema.ValueType	getValueType()	Type of value
int	hashCode()
ConfigurationPropertySchema.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

ConfigurationPropertySchema

@Deprecated
@ConstructorProperties({"keyName","valueType","description","isMandatory","defaultValue","validationRegexp","sampleValue"})
public ConfigurationPropertySchema(String keyName,
                                   ConfigurationPropertySchema.ValueType valueType,
                                   String description,
                                   Boolean isMandatory,
                                   String defaultValue,
                                   String validationRegexp,
                                   String sampleValue)

Deprecated.

Method Detail

builder

public static ConfigurationPropertySchema.Builder builder()

Create a new builder.

toBuilder

public ConfigurationPropertySchema.Builder toBuilder()

getKeyName

public String getKeyName()

Name of key (parameter name)

Returns:

the value

getValueType

public ConfigurationPropertySchema.ValueType getValueType()

Type of value

Returns:

the value

getDescription

public String getDescription()

Description of this configuration property

Returns:

the value

getIsMandatory

public Boolean getIsMandatory()

If the value is true this configuration property is mandatory and visa versa.

If not specified configuration property is optional.

Returns:

the value

getDefaultValue

public String getDefaultValue()

The default value for the optional configuration property (it must not be specified for mandatory configuration properties)

Returns:

the value

getValidationRegexp

public String getValidationRegexp()

A regular expression will be used for the validation of property value.

Returns:

the value

getSampleValue

public String getSampleValue()

Sample property value (it must match validationRegexp if it is specified)

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