Package com.oracle.bmc.databasetoolsruntime.model

Class DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary

java.lang.Object

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

com.oracle.bmc.databasetoolsruntime.model.DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary

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

Description of a database API gateway config setting to be provided as an advanced property.
Note: Objects should always be created or deserialized using the DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.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 DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.Builder, which maintain a set of all explicitly set fields called DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.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	DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.Builder
static class	DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.DatabaseToolsConnectionTypes
static class	DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.DataType	The data type of a database API gateway config setting.

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

DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary(String key, String displayName, DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.DataType dataType, List<DatabaseApiGatewayConfigAdvancedPropertyConfigType> configTypes, String categoryKey, String categoryDisplayName, List<DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.DatabaseToolsConnectionTypes> databaseToolsConnectionTypes, String documentationUrl, String description, String defaultValue, Integer minValue, Integer maxValue, List<String> listOfValues, String hintText)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCategoryDisplayName()	A user-friendly name of a category.
String	getCategoryKey()	The category of the Database Tools database API gateway config global setting.
List<DatabaseApiGatewayConfigAdvancedPropertyConfigType>	getConfigTypes()	The config types that support this advanced property.
List<DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.DatabaseToolsConnectionTypes>	getDatabaseToolsConnectionTypes()	The type of database (as determined by a type of Database Tools connection) to which this setting applies.
DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.DataType	getDataType()	The data type of a database API gateway config setting.
String	getDefaultValue()	The default value (if applicable) of a database API gateway config setting.
String	getDescription()	A user-friendly description of a database API gateway config setting.
String	getDisplayName()	A user-friendly name.
String	getDocumentationUrl()	Uniform resource locator (URL) of documentation related to this setting.
String	getHintText()	Hint text for a database API gateway config setting.
String	getKey()	A string that uniquely identifies a Database Tools database API gateway config global settings resource.
List<String>	getListOfValues()	A list of string values (if applicable) supported by this database API gateway config setting.
Integer	getMaxValue()	A maximum numeric value (if applicable) of a database API gateway config setting.
Integer	getMinValue()	A minimum numeric value (if applicable) of a database API gateway config setting.
int	hashCode()
DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.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

DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary

@Deprecated
@ConstructorProperties({"key","displayName","dataType","configTypes","categoryKey","categoryDisplayName","databaseToolsConnectionTypes","documentationUrl","description","defaultValue","minValue","maxValue","listOfValues","hintText"})
public DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary(String key,
                                                                    String displayName,
                                                                    DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.DataType dataType,
                                                                    List<DatabaseApiGatewayConfigAdvancedPropertyConfigType> configTypes,
                                                                    String categoryKey,
                                                                    String categoryDisplayName,
                                                                    List<DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.DatabaseToolsConnectionTypes> databaseToolsConnectionTypes,
                                                                    String documentationUrl,
                                                                    String description,
                                                                    String defaultValue,
                                                                    Integer minValue,
                                                                    Integer maxValue,
                                                                    List<String> listOfValues,
                                                                    String hintText)

Deprecated.

Method Detail

builder

public static DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.Builder builder()

Create a new builder.

toBuilder

public DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.Builder toBuilder()

getKey

public String getKey()

A string that uniquely identifies a Database Tools database API gateway config global settings resource.

Returns:

the value

getDisplayName

public String getDisplayName()

A user-friendly name.

Returns:

the value

getDataType

public DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.DataType getDataType()

The data type of a database API gateway config setting.

Returns:

the value

getConfigTypes

public List<DatabaseApiGatewayConfigAdvancedPropertyConfigType> getConfigTypes()

The config types that support this advanced property.

The supported types are GLOBAL and POOL.

Returns:

the value

getCategoryKey

public String getCategoryKey()

The category of the Database Tools database API gateway config global setting.

Returns:

the value

getCategoryDisplayName

public String getCategoryDisplayName()

A user-friendly name of a category.

Returns:

the value

getDatabaseToolsConnectionTypes

public List<DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.DatabaseToolsConnectionTypes> getDatabaseToolsConnectionTypes()

The type of database (as determined by a type of Database Tools connection) to which this setting applies.

The advancedProperty applies to all types of Database Tools connection when null. This is only applicable when configTypes includes POOL.

Returns:

the value

getDocumentationUrl

public String getDocumentationUrl()

Uniform resource locator (URL) of documentation related to this setting.

Returns:

the value

getDescription

public String getDescription()

A user-friendly description of a database API gateway config setting.

Returns:

the value

getDefaultValue

public String getDefaultValue()

The default value (if applicable) of a database API gateway config setting.

Returns:

the value

getMinValue

public Integer getMinValue()

A minimum numeric value (if applicable) of a database API gateway config setting.

Returns:

the value

getMaxValue

public Integer getMaxValue()

A maximum numeric value (if applicable) of a database API gateway config setting.

Returns:

the value

getListOfValues

public List<String> getListOfValues()

A list of string values (if applicable) supported by this database API gateway config setting.

Returns:

the value

getHintText

public String getHintText()

Hint text for a database API gateway config setting.

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