Google Cloud Oracle Database V1 Client - Class AutonomousDatabaseProperties (0.1.2)

Reference documentation and code samples for the Google Cloud Oracle Database V1 Client class AutonomousDatabaseProperties.

The properties of an Autonomous Database.

Generated from protobuf message google.cloud.oracledatabase.v1.AutonomousDatabaseProperties

Namespace

Google \ Cloud \ OracleDatabase \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ ocid string

Output only. OCID of the Autonomous Database. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle

↳ compute_count float

Optional. The number of compute servers for the Autonomous Database.

↳ cpu_core_count int

Optional. The number of CPU cores to be made available to the database.

↳ data_storage_size_tb int

Optional. The size of the data stored in the database, in terabytes.

↳ data_storage_size_gb int

Optional. The size of the data stored in the database, in gigabytes.

↳ db_workload int

Required. The workload type of the Autonomous Database.

↳ db_edition int

Optional. The edition of the Autonomous Databases.

↳ character_set string

Optional. The character set for the Autonomous Database. The default is AL32UTF8.

↳ n_character_set string

Optional. The national character set for the Autonomous Database. The default is AL16UTF16.

↳ private_endpoint_ip string

Optional. The private endpoint IP address for the Autonomous Database.

↳ private_endpoint_label string

Optional. The private endpoint label for the Autonomous Database.

↳ db_version string

Optional. The Oracle Database version for the Autonomous Database.

↳ is_auto_scaling_enabled bool

Optional. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count.

↳ is_storage_auto_scaling_enabled bool

Optional. This field indicates if auto scaling is enabled for the Autonomous Database storage.

↳ license_type int

Required. The license type used for the Autonomous Database.

↳ customer_contacts array<CustomerContact>

Optional. The list of customer contacts.

↳ secret_id string

Optional. The ID of the Oracle Cloud Infrastructure vault secret.

↳ vault_id string

Optional. The ID of the Oracle Cloud Infrastructure vault.

↳ maintenance_schedule_type int

Optional. The maintenance schedule of the Autonomous Database.

↳ mtls_connection_required bool

Optional. This field specifies if the Autonomous Database requires mTLS connections.

↳ backup_retention_period_days int

Optional. The retention period for the Autonomous Database. This field is specified in days, can range from 1 day to 60 days, and has a default value of 60 days.

↳ actual_used_data_storage_size_tb float

Output only. The amount of storage currently being used for user and system data, in terabytes.

↳ allocated_storage_size_tb float

Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes.

↳ apex_details AutonomousDatabaseApex

Output only. The details for the Oracle APEX Application Development.

↳ are_primary_allowlisted_ips_used bool

Output only. This field indicates the status of Data Guard and Access control for the Autonomous Database. The field's value is null if Data Guard is disabled or Access Control is disabled. The field's value is TRUE if both Data Guard and Access Control are enabled, and the Autonomous Database is using primary IP access control list (ACL) for standby. The field's value is FALSE if both Data Guard and Access Control are enabled, and the Autonomous Database is using a different IP access control list (ACL) for standby compared to primary.

↳ lifecycle_details string

Output only. The details of the current lifestyle state of the Autonomous Database.

↳ state int

Output only. The current lifecycle state of the Autonomous Database.

↳ autonomous_container_database_id string

Output only. The Autonomous Container Database OCID.

↳ available_upgrade_versions array

Output only. The list of available Oracle Database upgrade versions for an Autonomous Database.

↳ connection_strings AutonomousDatabaseConnectionStrings

Output only. The connection strings used to connect to an Autonomous Database.

↳ connection_urls AutonomousDatabaseConnectionUrls

Output only. The Oracle Connection URLs for an Autonomous Database.

↳ failed_data_recovery_duration Google\Protobuf\Duration

Output only. This field indicates the number of seconds of data loss during a Data Guard failover.

↳ memory_table_gbs int

Output only. The memory assigned to in-memory tables in an Autonomous Database.

↳ is_local_data_guard_enabled bool

Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled.

↳ local_adg_auto_failover_max_data_loss_limit int

Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.

↳ local_standby_db AutonomousDatabaseStandbySummary

Output only. The details of the Autonomous Data Guard standby database.

↳ memory_per_oracle_compute_unit_gbs int

Output only. The amount of memory enabled per ECPU, in gigabytes.

↳ local_disaster_recovery_type int

Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database.

↳ data_safe_state int

Output only. The current state of the Data Safe registration for the Autonomous Database.

↳ database_management_state int

Output only. The current state of database management for the Autonomous Database.

↳ open_mode int

Output only. This field indicates the current mode of the Autonomous Database.

↳ operations_insights_state int

Output only. This field indicates the state of Operations Insights for the Autonomous Database.

↳ peer_db_ids array

Output only. The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database.

↳ permission_level int

Output only. The permission level of the Autonomous Database.

↳ private_endpoint string

Output only. The private endpoint for the Autonomous Database.

↳ refreshable_mode int

Output only. The refresh mode of the cloned Autonomous Database.

↳ refreshable_state int

Output only. The refresh State of the clone.

↳ role int

Output only. The Data Guard role of the Autonomous Database.

↳ scheduled_operation_details array<ScheduledOperationDetails>

Output only. The list and details of the scheduled operations of the Autonomous Database.

↳ sql_web_developer_url string

Output only. The SQL Web Developer URL for the Autonomous Database.

↳ supported_clone_regions array

Output only. The list of available regions that can be used to create a clone for the Autonomous Database.

↳ used_data_storage_size_tbs int

Output only. The storage space used by Autonomous Database, in gigabytes.

↳ oci_url string

Output only. The Oracle Cloud Infrastructure link for the Autonomous Database.

↳ total_auto_backup_storage_size_gbs float

Output only. The storage space used by automatic backups of Autonomous Database, in gigabytes.

↳ next_long_term_backup_time Google\Protobuf\Timestamp

Output only. The long term backup schedule of the Autonomous Database.

↳ maintenance_begin_time Google\Protobuf\Timestamp

Output only. The date and time when maintenance will begin.

↳ maintenance_end_time Google\Protobuf\Timestamp

Output only. The date and time when maintenance will end.

getOcid

Returns
Type Description
string

setOcid

Parameter
Name Description
var string
Returns
Type Description
$this

getComputeCount

Optional. The number of compute servers for the Autonomous Database.

Returns
Type Description
float

setComputeCount

Optional. The number of compute servers for the Autonomous Database.

Parameter
Name Description
var float
Returns
Type Description
$this

getCpuCoreCount

Optional. The number of CPU cores to be made available to the database.

Returns
Type Description
int

setCpuCoreCount

Optional. The number of CPU cores to be made available to the database.

Parameter
Name Description
var int
Returns
Type Description
$this

getDataStorageSizeTb

Optional. The size of the data stored in the database, in terabytes.

Returns
Type Description
int

setDataStorageSizeTb

Optional. The size of the data stored in the database, in terabytes.

Parameter
Name Description
var int
Returns
Type Description
$this

getDataStorageSizeGb

Optional. The size of the data stored in the database, in gigabytes.

Returns
Type Description
int

setDataStorageSizeGb

Optional. The size of the data stored in the database, in gigabytes.

Parameter
Name Description
var int
Returns
Type Description
$this

getDbWorkload

Required. The workload type of the Autonomous Database.

Returns
Type Description
int

setDbWorkload

Required. The workload type of the Autonomous Database.

Parameter
Name Description
var int
Returns
Type Description
$this

getDbEdition

Optional. The edition of the Autonomous Databases.

Returns
Type Description
int

setDbEdition

Optional. The edition of the Autonomous Databases.

Parameter
Name Description
var int
Returns
Type Description
$this

getCharacterSet

Optional. The character set for the Autonomous Database. The default is AL32UTF8.

Returns
Type Description
string

setCharacterSet

Optional. The character set for the Autonomous Database. The default is AL32UTF8.

Parameter
Name Description
var string
Returns
Type Description
$this

getNCharacterSet

Optional. The national character set for the Autonomous Database. The default is AL16UTF16.

Returns
Type Description
string

setNCharacterSet

Optional. The national character set for the Autonomous Database. The default is AL16UTF16.

Parameter
Name Description
var string
Returns
Type Description
$this

getPrivateEndpointIp

Optional. The private endpoint IP address for the Autonomous Database.

Returns
Type Description
string

setPrivateEndpointIp

Optional. The private endpoint IP address for the Autonomous Database.

Parameter
Name Description
var string
Returns
Type Description
$this

getPrivateEndpointLabel

Optional. The private endpoint label for the Autonomous Database.

Returns
Type Description
string

setPrivateEndpointLabel

Optional. The private endpoint label for the Autonomous Database.

Parameter
Name Description
var string
Returns
Type Description
$this

getDbVersion

Optional. The Oracle Database version for the Autonomous Database.

Returns
Type Description
string

setDbVersion

Optional. The Oracle Database version for the Autonomous Database.

Parameter
Name Description
var string
Returns
Type Description
$this

getIsAutoScalingEnabled

Optional. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count.

Returns
Type Description
bool

setIsAutoScalingEnabled

Optional. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count.

Parameter
Name Description
var bool
Returns
Type Description
$this

getIsStorageAutoScalingEnabled

Optional. This field indicates if auto scaling is enabled for the Autonomous Database storage.

Returns
Type Description
bool

setIsStorageAutoScalingEnabled

Optional. This field indicates if auto scaling is enabled for the Autonomous Database storage.

Parameter
Name Description
var bool
Returns
Type Description
$this

getLicenseType

Required. The license type used for the Autonomous Database.

Returns
Type Description
int

setLicenseType

Required. The license type used for the Autonomous Database.

Parameter
Name Description
var int
Returns
Type Description
$this

getCustomerContacts

Optional. The list of customer contacts.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setCustomerContacts

Optional. The list of customer contacts.

Parameter
Name Description
var array<CustomerContact>
Returns
Type Description
$this

getSecretId

Optional. The ID of the Oracle Cloud Infrastructure vault secret.

Returns
Type Description
string

setSecretId

Optional. The ID of the Oracle Cloud Infrastructure vault secret.

Parameter
Name Description
var string
Returns
Type Description
$this

getVaultId

Optional. The ID of the Oracle Cloud Infrastructure vault.

Returns
Type Description
string

setVaultId

Optional. The ID of the Oracle Cloud Infrastructure vault.

Parameter
Name Description
var string
Returns
Type Description
$this

getMaintenanceScheduleType

Optional. The maintenance schedule of the Autonomous Database.

Returns
Type Description
int

setMaintenanceScheduleType

Optional. The maintenance schedule of the Autonomous Database.

Parameter
Name Description
var int
Returns
Type Description
$this

getMtlsConnectionRequired

Optional. This field specifies if the Autonomous Database requires mTLS connections.

Returns
Type Description
bool

setMtlsConnectionRequired

Optional. This field specifies if the Autonomous Database requires mTLS connections.

Parameter
Name Description
var bool
Returns
Type Description
$this

getBackupRetentionPeriodDays

Optional. The retention period for the Autonomous Database. This field is specified in days, can range from 1 day to 60 days, and has a default value of 60 days.

Returns
Type Description
int

setBackupRetentionPeriodDays

Optional. The retention period for the Autonomous Database. This field is specified in days, can range from 1 day to 60 days, and has a default value of 60 days.

Parameter
Name Description
var int
Returns
Type Description
$this

getActualUsedDataStorageSizeTb

Output only. The amount of storage currently being used for user and system data, in terabytes.

Returns
Type Description
float

setActualUsedDataStorageSizeTb

Output only. The amount of storage currently being used for user and system data, in terabytes.

Parameter
Name Description
var float
Returns
Type Description
$this

getAllocatedStorageSizeTb

Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes.

Returns
Type Description
float

setAllocatedStorageSizeTb

Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes.

Parameter
Name Description
var float
Returns
Type Description
$this

getApexDetails

Output only. The details for the Oracle APEX Application Development.

Returns
Type Description
AutonomousDatabaseApex|null

hasApexDetails

clearApexDetails

setApexDetails

Output only. The details for the Oracle APEX Application Development.

Parameter
Name Description
var AutonomousDatabaseApex
Returns
Type Description
$this

getArePrimaryAllowlistedIpsUsed

Output only. This field indicates the status of Data Guard and Access control for the Autonomous Database. The field's value is null if Data Guard is disabled or Access Control is disabled. The field's value is TRUE if both Data Guard and Access Control are enabled, and the Autonomous Database is using primary IP access control list (ACL) for standby. The field's value is FALSE if both Data Guard and Access Control are enabled, and the Autonomous Database is using a different IP access control list (ACL) for standby compared to primary.

Returns
Type Description
bool

hasArePrimaryAllowlistedIpsUsed

clearArePrimaryAllowlistedIpsUsed

setArePrimaryAllowlistedIpsUsed

Output only. This field indicates the status of Data Guard and Access control for the Autonomous Database. The field's value is null if Data Guard is disabled or Access Control is disabled. The field's value is TRUE if both Data Guard and Access Control are enabled, and the Autonomous Database is using primary IP access control list (ACL) for standby. The field's value is FALSE if both Data Guard and Access Control are enabled, and the Autonomous Database is using a different IP access control list (ACL) for standby compared to primary.

Parameter
Name Description
var bool
Returns
Type Description
$this

getLifecycleDetails

Output only. The details of the current lifestyle state of the Autonomous Database.

Returns
Type Description
string

setLifecycleDetails

Output only. The details of the current lifestyle state of the Autonomous Database.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. The current lifecycle state of the Autonomous Database.

Returns
Type Description
int

setState

Output only. The current lifecycle state of the Autonomous Database.

Parameter
Name Description
var int
Returns
Type Description
$this

getAutonomousContainerDatabaseId

Output only. The Autonomous Container Database OCID.

Returns
Type Description
string

setAutonomousContainerDatabaseId

Output only. The Autonomous Container Database OCID.

Parameter
Name Description
var string
Returns
Type Description
$this

getAvailableUpgradeVersions

Output only. The list of available Oracle Database upgrade versions for an Autonomous Database.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAvailableUpgradeVersions

Output only. The list of available Oracle Database upgrade versions for an Autonomous Database.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getConnectionStrings

Output only. The connection strings used to connect to an Autonomous Database.

Returns
Type Description
AutonomousDatabaseConnectionStrings|null

hasConnectionStrings

clearConnectionStrings

setConnectionStrings

Output only. The connection strings used to connect to an Autonomous Database.

Parameter
Name Description
var AutonomousDatabaseConnectionStrings
Returns
Type Description
$this

getConnectionUrls

Output only. The Oracle Connection URLs for an Autonomous Database.

Returns
Type Description
AutonomousDatabaseConnectionUrls|null

hasConnectionUrls

clearConnectionUrls

setConnectionUrls

Output only. The Oracle Connection URLs for an Autonomous Database.

Parameter
Name Description
var AutonomousDatabaseConnectionUrls
Returns
Type Description
$this

getFailedDataRecoveryDuration

Output only. This field indicates the number of seconds of data loss during a Data Guard failover.

Returns
Type Description
Google\Protobuf\Duration|null

hasFailedDataRecoveryDuration

clearFailedDataRecoveryDuration

setFailedDataRecoveryDuration

Output only. This field indicates the number of seconds of data loss during a Data Guard failover.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getMemoryTableGbs

Output only. The memory assigned to in-memory tables in an Autonomous Database.

Returns
Type Description
int

setMemoryTableGbs

Output only. The memory assigned to in-memory tables in an Autonomous Database.

Parameter
Name Description
var int
Returns
Type Description
$this

getIsLocalDataGuardEnabled

Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled.

Returns
Type Description
bool

setIsLocalDataGuardEnabled

Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled.

Parameter
Name Description
var bool
Returns
Type Description
$this

getLocalAdgAutoFailoverMaxDataLossLimit

Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.

Returns
Type Description
int

setLocalAdgAutoFailoverMaxDataLossLimit

Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.

Parameter
Name Description
var int
Returns
Type Description
$this

getLocalStandbyDb

Output only. The details of the Autonomous Data Guard standby database.

Returns
Type Description
AutonomousDatabaseStandbySummary|null

hasLocalStandbyDb

clearLocalStandbyDb

setLocalStandbyDb

Output only. The details of the Autonomous Data Guard standby database.

Parameter
Name Description
var AutonomousDatabaseStandbySummary
Returns
Type Description
$this

getMemoryPerOracleComputeUnitGbs

Output only. The amount of memory enabled per ECPU, in gigabytes.

Returns
Type Description
int

setMemoryPerOracleComputeUnitGbs

Output only. The amount of memory enabled per ECPU, in gigabytes.

Parameter
Name Description
var int
Returns
Type Description
$this

getLocalDisasterRecoveryType

Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database.

Returns
Type Description
int

setLocalDisasterRecoveryType

Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database.

Parameter
Name Description
var int
Returns
Type Description
$this

getDataSafeState

Output only. The current state of the Data Safe registration for the Autonomous Database.

Returns
Type Description
int

setDataSafeState

Output only. The current state of the Data Safe registration for the Autonomous Database.

Parameter
Name Description
var int
Returns
Type Description
$this

getDatabaseManagementState

Output only. The current state of database management for the Autonomous Database.

Returns
Type Description
int

setDatabaseManagementState

Output only. The current state of database management for the Autonomous Database.

Parameter
Name Description
var int
Returns
Type Description
$this

getOpenMode

Output only. This field indicates the current mode of the Autonomous Database.

Returns
Type Description
int

setOpenMode

Output only. This field indicates the current mode of the Autonomous Database.

Parameter
Name Description
var int
Returns
Type Description
$this

getOperationsInsightsState

Output only. This field indicates the state of Operations Insights for the Autonomous Database.

Returns
Type Description
int

setOperationsInsightsState

Output only. This field indicates the state of Operations Insights for the Autonomous Database.

Parameter
Name Description
var int
Returns
Type Description
$this

getPeerDbIds

Output only. The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setPeerDbIds

Output only. The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getPermissionLevel

Output only. The permission level of the Autonomous Database.

Returns
Type Description
int

setPermissionLevel

Output only. The permission level of the Autonomous Database.

Parameter
Name Description
var int
Returns
Type Description
$this

getPrivateEndpoint

Output only. The private endpoint for the Autonomous Database.

Returns
Type Description
string

setPrivateEndpoint

Output only. The private endpoint for the Autonomous Database.

Parameter
Name Description
var string
Returns
Type Description
$this

getRefreshableMode

Output only. The refresh mode of the cloned Autonomous Database.

Returns
Type Description
int

setRefreshableMode

Output only. The refresh mode of the cloned Autonomous Database.

Parameter
Name Description
var int
Returns
Type Description
$this

getRefreshableState

Output only. The refresh State of the clone.

Returns
Type Description
int

setRefreshableState

Output only. The refresh State of the clone.

Parameter
Name Description
var int
Returns
Type Description
$this

getRole

Output only. The Data Guard role of the Autonomous Database.

Returns
Type Description
int

setRole

Output only. The Data Guard role of the Autonomous Database.

Parameter
Name Description
var int
Returns
Type Description
$this

getScheduledOperationDetails

Output only. The list and details of the scheduled operations of the Autonomous Database.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setScheduledOperationDetails

Output only. The list and details of the scheduled operations of the Autonomous Database.

Parameter
Name Description
var array<ScheduledOperationDetails>
Returns
Type Description
$this

getSqlWebDeveloperUrl

Output only. The SQL Web Developer URL for the Autonomous Database.

Returns
Type Description
string

setSqlWebDeveloperUrl

Output only. The SQL Web Developer URL for the Autonomous Database.

Parameter
Name Description
var string
Returns
Type Description
$this

getSupportedCloneRegions

Output only. The list of available regions that can be used to create a clone for the Autonomous Database.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSupportedCloneRegions

Output only. The list of available regions that can be used to create a clone for the Autonomous Database.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getUsedDataStorageSizeTbs

Output only. The storage space used by Autonomous Database, in gigabytes.

Returns
Type Description
int

setUsedDataStorageSizeTbs

Output only. The storage space used by Autonomous Database, in gigabytes.

Parameter
Name Description
var int
Returns
Type Description
$this

getOciUrl

Output only. The Oracle Cloud Infrastructure link for the Autonomous Database.

Returns
Type Description
string

setOciUrl

Output only. The Oracle Cloud Infrastructure link for the Autonomous Database.

Parameter
Name Description
var string
Returns
Type Description
$this

getTotalAutoBackupStorageSizeGbs

Output only. The storage space used by automatic backups of Autonomous Database, in gigabytes.

Returns
Type Description
float

setTotalAutoBackupStorageSizeGbs

Output only. The storage space used by automatic backups of Autonomous Database, in gigabytes.

Parameter
Name Description
var float
Returns
Type Description
$this

getNextLongTermBackupTime

Output only. The long term backup schedule of the Autonomous Database.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasNextLongTermBackupTime

clearNextLongTermBackupTime

setNextLongTermBackupTime

Output only. The long term backup schedule of the Autonomous Database.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getMaintenanceBeginTime

Output only. The date and time when maintenance will begin.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasMaintenanceBeginTime

clearMaintenanceBeginTime

setMaintenanceBeginTime

Output only. The date and time when maintenance will begin.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getMaintenanceEndTime

Output only. The date and time when maintenance will end.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasMaintenanceEndTime

clearMaintenanceEndTime

setMaintenanceEndTime

Output only. The date and time when maintenance will end.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this