target.apidocs.com.google.api.services.sqladmin.model.BackupConfiguration.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-sqladmin Show documentation

The newest version!







BackupConfiguration (Cloud SQL Admin API v1-rev20241108-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.sqladmin.model
Class BackupConfiguration



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.sqladmin.model.BackupConfiguration













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class BackupConfiguration
extends com.google.api.client.json.GenericJson
Database instance backup configuration.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Cloud SQL Admin API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


BackupConfiguration() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


BackupConfiguration
clone() 


BackupRetentionSettings
getBackupRetentionSettings()
Backup retention settings.



Boolean
getBinaryLogEnabled()
(MySQL only) Whether binary log is enabled.



Boolean
getEnabled()
Whether this configuration is enabled.



String
getKind()
This is always `sql#backupConfiguration`.



String
getLocation()
Location of the backup



Boolean
getPointInTimeRecoveryEnabled()
Whether point in time recovery is enabled.



Boolean
getReplicationLogArchivingEnabled()
Reserved for future use.



String
getStartTime()
Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`.



String
getTransactionalLogStorageState()
Output only.



Integer
getTransactionLogRetentionDays()
The number of days of transaction logs we retain for point in time restore, from 1-7.



BackupConfiguration
set(String fieldName,
   Object value) 


BackupConfiguration
setBackupRetentionSettings(BackupRetentionSettings backupRetentionSettings)
Backup retention settings.



BackupConfiguration
setBinaryLogEnabled(Boolean binaryLogEnabled)
(MySQL only) Whether binary log is enabled.



BackupConfiguration
setEnabled(Boolean enabled)
Whether this configuration is enabled.



BackupConfiguration
setKind(String kind)
This is always `sql#backupConfiguration`.



BackupConfiguration
setLocation(String location)
Location of the backup



BackupConfiguration
setPointInTimeRecoveryEnabled(Boolean pointInTimeRecoveryEnabled)
Whether point in time recovery is enabled.



BackupConfiguration
setReplicationLogArchivingEnabled(Boolean replicationLogArchivingEnabled)
Reserved for future use.



BackupConfiguration
setStartTime(String startTime)
Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`.



BackupConfiguration
setTransactionalLogStorageState(String transactionalLogStorageState)
Output only.



BackupConfiguration
setTransactionLogRetentionDays(Integer transactionLogRetentionDays)
The number of days of transaction logs we retain for point in time restore, from 1-7.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





BackupConfiguration
public BackupConfiguration()









Method Detail





getBackupRetentionSettings
public BackupRetentionSettings getBackupRetentionSettings()
Backup retention settings.

Returns:
value or null for none








setBackupRetentionSettings
public BackupConfiguration setBackupRetentionSettings(BackupRetentionSettings backupRetentionSettings)
Backup retention settings.

Parameters:
backupRetentionSettings - backupRetentionSettings or null for none








getBinaryLogEnabled
public Boolean getBinaryLogEnabled()
(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must
 be disabled as well.

Returns:
value or null for none








setBinaryLogEnabled
public BackupConfiguration setBinaryLogEnabled(Boolean binaryLogEnabled)
(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must
 be disabled as well.

Parameters:
binaryLogEnabled - binaryLogEnabled or null for none








getEnabled
public Boolean getEnabled()
Whether this configuration is enabled.

Returns:
value or null for none








setEnabled
public BackupConfiguration setEnabled(Boolean enabled)
Whether this configuration is enabled.

Parameters:
enabled - enabled or null for none








getKind
public String getKind()
This is always `sql#backupConfiguration`.

Returns:
value or null for none








setKind
public BackupConfiguration setKind(String kind)
This is always `sql#backupConfiguration`.

Parameters:
kind - kind or null for none








getLocation
public String getLocation()
Location of the backup

Returns:
value or null for none








setLocation
public BackupConfiguration setLocation(String location)
Location of the backup

Parameters:
location - location or null for none








getPointInTimeRecoveryEnabled
public Boolean getPointInTimeRecoveryEnabled()
Whether point in time recovery is enabled.

Returns:
value or null for none








setPointInTimeRecoveryEnabled
public BackupConfiguration setPointInTimeRecoveryEnabled(Boolean pointInTimeRecoveryEnabled)
Whether point in time recovery is enabled.

Parameters:
pointInTimeRecoveryEnabled - pointInTimeRecoveryEnabled or null for none








getReplicationLogArchivingEnabled
public Boolean getReplicationLogArchivingEnabled()
Reserved for future use.

Returns:
value or null for none








setReplicationLogArchivingEnabled
public BackupConfiguration setReplicationLogArchivingEnabled(Boolean replicationLogArchivingEnabled)
Reserved for future use.

Parameters:
replicationLogArchivingEnabled - replicationLogArchivingEnabled or null for none








getStartTime
public String getStartTime()
Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`.

Returns:
value or null for none








setStartTime
public BackupConfiguration setStartTime(String startTime)
Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`.

Parameters:
startTime - startTime or null for none








getTransactionLogRetentionDays
public Integer getTransactionLogRetentionDays()
The number of days of transaction logs we retain for point in time restore, from 1-7.

Returns:
value or null for none








setTransactionLogRetentionDays
public BackupConfiguration setTransactionLogRetentionDays(Integer transactionLogRetentionDays)
The number of days of transaction logs we retain for point in time restore, from 1-7.

Parameters:
transactionLogRetentionDays - transactionLogRetentionDays or null for none








getTransactionalLogStorageState
public String getTransactionalLogStorageState()
Output only. This value contains the storage location of transactional logs used to perform
 point-in-time recovery (PITR) for the database.

Returns:
value or null for none








setTransactionalLogStorageState
public BackupConfiguration setTransactionalLogStorageState(String transactionalLogStorageState)
Output only. This value contains the storage location of transactional logs used to perform
 point-in-time recovery (PITR) for the database.

Parameters:
transactionalLogStorageState - transactionalLogStorageState or null for none








set
public BackupConfiguration set(String fieldName,
                               Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public BackupConfiguration clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`BackupConfiguration`	`clone()`
`BackupRetentionSettings`	`getBackupRetentionSettings()` Backup retention settings.
`Boolean`	`getBinaryLogEnabled()` (MySQL only) Whether binary log is enabled.
`Boolean`	`getEnabled()` Whether this configuration is enabled.
`String`	`getKind()` This is always `sql#backupConfiguration`.
`String`	`getLocation()` Location of the backup
`Boolean`	`getPointInTimeRecoveryEnabled()` Whether point in time recovery is enabled.
`Boolean`	`getReplicationLogArchivingEnabled()` Reserved for future use.
`String`	`getStartTime()` Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`.
`String`	`getTransactionalLogStorageState()` Output only.
`Integer`	`getTransactionLogRetentionDays()` The number of days of transaction logs we retain for point in time restore, from 1-7.
`BackupConfiguration`	`set(String fieldName, Object value)`
`BackupConfiguration`	`setBackupRetentionSettings(BackupRetentionSettings backupRetentionSettings)` Backup retention settings.
`BackupConfiguration`	`setBinaryLogEnabled(Boolean binaryLogEnabled)` (MySQL only) Whether binary log is enabled.
`BackupConfiguration`	`setEnabled(Boolean enabled)` Whether this configuration is enabled.
`BackupConfiguration`	`setKind(String kind)` This is always `sql#backupConfiguration`.
`BackupConfiguration`	`setLocation(String location)` Location of the backup
`BackupConfiguration`	`setPointInTimeRecoveryEnabled(Boolean pointInTimeRecoveryEnabled)` Whether point in time recovery is enabled.
`BackupConfiguration`	`setReplicationLogArchivingEnabled(Boolean replicationLogArchivingEnabled)` Reserved for future use.
`BackupConfiguration`	`setStartTime(String startTime)` Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`.
`BackupConfiguration`	`setTransactionalLogStorageState(String transactionalLogStorageState)` Output only.
`BackupConfiguration`	`setTransactionLogRetentionDays(Integer transactionLogRetentionDays)` The number of days of transaction logs we retain for point in time restore, from 1-7.