Package com.oracle.bmc.databasetoolsruntime.model

Class DatabaseToolsDatabaseApiGatewayConfigGlobal

java.lang.Object

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

com.oracle.bmc.databasetoolsruntime.model.DatabaseToolsDatabaseApiGatewayConfigGlobal

Direct Known Subclasses:

DatabaseToolsDatabaseApiGatewayConfigGlobalDefault

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

The content of a Database Tools database API gateway config global resource.
Note: Objects should always be created or deserialized using the 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 Builder, which maintain a set of all explicitly set fields called 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	DatabaseToolsDatabaseApiGatewayConfigGlobal.DatabaseApiStatus	ORDS database API is a database management and monitoring REST API.
static class	DatabaseToolsDatabaseApiGatewayConfigGlobal.MetadataSource	The RESTful service definition location.
static class	DatabaseToolsDatabaseApiGatewayConfigGlobal.PoolRoute	How the target pool route value is determined for a HTTP request.

Field Summary

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

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DatabaseToolsDatabaseApiGatewayConfigGlobal(String key, DatabaseToolsDatabaseApiGatewayConfigGlobal.PoolRoute poolRoute, String poolRoutingHeader, DatabaseToolsDatabaseApiGatewayConfigGlobal.DatabaseApiStatus databaseApiStatus, DatabaseToolsDatabaseApiGatewayConfigGlobal.MetadataSource metadataSource, Integer httpPort, Integer httpsPort, DatabaseApiGatewayConfigCertificateBundle certificateBundle, String documentRoot, Map<String,String> advancedProperties, Date timeCreated, Date timeUpdated)	Deprecated.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Map<String,String>	getAdvancedProperties()	Advanced global properties.
DatabaseApiGatewayConfigCertificateBundle	getCertificateBundle()
DatabaseToolsDatabaseApiGatewayConfigGlobal.DatabaseApiStatus	getDatabaseApiStatus()	ORDS database API is a database management and monitoring REST API.
String	getDocumentRoot()	The location of the static resources to be served under the / root server path.
Integer	getHttpPort()	Specifies the HTTP listen port.
Integer	getHttpsPort()	Specifies the HTTPS listen port.
String	getKey()	A string that uniquely identifies a Database Tools database API gateway config global settings resource.
DatabaseToolsDatabaseApiGatewayConfigGlobal.MetadataSource	getMetadataSource()	The RESTful service definition location.
DatabaseToolsDatabaseApiGatewayConfigGlobal.PoolRoute	getPoolRoute()	How the target pool route value is determined for a HTTP request.
String	getPoolRoutingHeader()	The request header name providing the pool route value.
Date	getTimeCreated()	The time the resource was created.
Date	getTimeUpdated()	The time the resource was updated.
int	hashCode()
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

DatabaseToolsDatabaseApiGatewayConfigGlobal

@Deprecated
@ConstructorProperties({"key","poolRoute","poolRoutingHeader","databaseApiStatus","metadataSource","httpPort","httpsPort","certificateBundle","documentRoot","advancedProperties","timeCreated","timeUpdated"})
protected DatabaseToolsDatabaseApiGatewayConfigGlobal(String key,
                                                      DatabaseToolsDatabaseApiGatewayConfigGlobal.PoolRoute poolRoute,
                                                      String poolRoutingHeader,
                                                      DatabaseToolsDatabaseApiGatewayConfigGlobal.DatabaseApiStatus databaseApiStatus,
                                                      DatabaseToolsDatabaseApiGatewayConfigGlobal.MetadataSource metadataSource,
                                                      Integer httpPort,
                                                      Integer httpsPort,
                                                      DatabaseApiGatewayConfigCertificateBundle certificateBundle,
                                                      String documentRoot,
                                                      Map<String,String> advancedProperties,
                                                      Date timeCreated,
                                                      Date timeUpdated)

Deprecated.

Method Detail

getKey

public String getKey()

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

Returns:

the value

getPoolRoute

public DatabaseToolsDatabaseApiGatewayConfigGlobal.PoolRoute getPoolRoute()

How the target pool route value is determined for a HTTP request.

Returns:

the value

getPoolRoutingHeader

public String getPoolRoutingHeader()

The request header name providing the pool route value.

Returns:

the value

getDatabaseApiStatus

public DatabaseToolsDatabaseApiGatewayConfigGlobal.DatabaseApiStatus getDatabaseApiStatus()

ORDS database API is a database management and monitoring REST API.

Database Actions requires this feature.

Returns:

the value

getMetadataSource

public DatabaseToolsDatabaseApiGatewayConfigGlobal.MetadataSource getMetadataSource()

The RESTful service definition location.

Returns:

the value

getHttpPort

public Integer getHttpPort()

Specifies the HTTP listen port.

0 disables HTTP. Use of ports below 1024 requires elevated (root) privileges and is generally discouraged; deployment on non-privileged ports (1024\u201365535) is recommended.

Returns:

the value

getHttpsPort

public Integer getHttpsPort()

Specifies the HTTPS listen port.

0 disables HTTPS. Use of ports below 1024 requires elevated (root) privileges and is generally discouraged; deployment on non-privileged ports (1024\u201365535) is recommended. ORDS will use a self-signed certificate if a certificate bundle is not provided.

Returns:

the value

getCertificateBundle

public DatabaseApiGatewayConfigCertificateBundle getCertificateBundle()

getDocumentRoot

public String getDocumentRoot()

The location of the static resources to be served under the / root server path.

Returns:

the value

getAdvancedProperties

public Map<String,String> getAdvancedProperties()

Advanced global properties.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The time the resource was created.

An RFC3339 formatted datetime string.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The time the resource was updated.

An RFC3339 formatted datetime string.

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