sqladmin  v1beta4
Public Member Functions | Static Public Member Functions | List of all members
google_sqladmin_api::Settings Class Reference

#include <settings.h>

Inheritance diagram for google_sqladmin_api::Settings:

Public Member Functions

 Settings (const Json::Value &storage)
 
 Settings (Json::Value *storage)
 
virtual ~Settings ()
 
const StringPiece GetTypeName () const
 
bool has_activation_policy () const
 
void clear_activation_policy ()
 
const StringPiece get_activation_policy () const
 
void set_activation_policy (const StringPiece &value)
 
bool has_authorized_gae_applications () const
 
void clear_authorized_gae_applications ()
 
const client::JsonCppArray< string > get_authorized_gae_applications () const
 
client::JsonCppArray< string > mutable_authorizedGaeApplications ()
 
bool has_availability_type () const
 
void clear_availability_type ()
 
const StringPiece get_availability_type () const
 
void set_availability_type (const StringPiece &value)
 
bool has_backup_configuration () const
 
void clear_backup_configuration ()
 
const BackupConfiguration get_backup_configuration () const
 
BackupConfiguration mutable_backupConfiguration ()
 
bool has_crash_safe_replication_enabled () const
 
void clear_crash_safe_replication_enabled ()
 
bool get_crash_safe_replication_enabled () const
 
void set_crash_safe_replication_enabled (bool value)
 
bool has_data_disk_size_gb () const
 
void clear_data_disk_size_gb ()
 
int64 get_data_disk_size_gb () const
 
void set_data_disk_size_gb (int64 value)
 
bool has_data_disk_type () const
 
void clear_data_disk_type ()
 
const StringPiece get_data_disk_type () const
 
void set_data_disk_type (const StringPiece &value)
 
bool has_database_flags () const
 
void clear_database_flags ()
 
const client::JsonCppArray< DatabaseFlagsget_database_flags () const
 
client::JsonCppArray< DatabaseFlagsmutable_databaseFlags ()
 
bool has_database_replication_enabled () const
 
void clear_database_replication_enabled ()
 
bool get_database_replication_enabled () const
 
void set_database_replication_enabled (bool value)
 
bool has_ip_configuration () const
 
void clear_ip_configuration ()
 
const IpConfiguration get_ip_configuration () const
 
IpConfiguration mutable_ipConfiguration ()
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_location_preference () const
 
void clear_location_preference ()
 
const LocationPreference get_location_preference () const
 
LocationPreference mutable_locationPreference ()
 
bool has_maintenance_window () const
 
void clear_maintenance_window ()
 
const MaintenanceWindow get_maintenance_window () const
 
MaintenanceWindow mutable_maintenanceWindow ()
 
bool has_pricing_plan () const
 
void clear_pricing_plan ()
 
const StringPiece get_pricing_plan () const
 
void set_pricing_plan (const StringPiece &value)
 
bool has_replication_type () const
 
void clear_replication_type ()
 
const StringPiece get_replication_type () const
 
void set_replication_type (const StringPiece &value)
 
bool has_settings_version () const
 
void clear_settings_version ()
 
int64 get_settings_version () const
 
void set_settings_version (int64 value)
 
bool has_storage_auto_resize () const
 
void clear_storage_auto_resize ()
 
bool get_storage_auto_resize () const
 
void set_storage_auto_resize (bool value)
 
bool has_storage_auto_resize_limit () const
 
void clear_storage_auto_resize_limit ()
 
int64 get_storage_auto_resize_limit () const
 
void set_storage_auto_resize_limit (int64 value)
 
bool has_tier () const
 
void clear_tier ()
 
const StringPiece get_tier () const
 
void set_tier (const StringPiece &value)
 
bool has_user_labels () const
 
void clear_user_labels ()
 
const client::JsonCppAssociativeArray< string > get_user_labels () const
 
client::JsonCppAssociativeArray< string > mutable_userLabels ()
 

Static Public Member Functions

static SettingsNew ()
 

Detailed Description

Database instance settings.

Constructor & Destructor Documentation

◆ Settings() [1/2]

google_sqladmin_api::Settings::Settings ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ Settings() [2/2]

google_sqladmin_api::Settings::Settings ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~Settings()

google_sqladmin_api::Settings::~Settings ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_activation_policy()

void google_sqladmin_api::Settings::clear_activation_policy ( )
inline

Clears the 'activationPolicy' attribute.

◆ clear_authorized_gae_applications()

void google_sqladmin_api::Settings::clear_authorized_gae_applications ( )
inline

Clears the 'authorizedGaeApplications' attribute.

◆ clear_availability_type()

void google_sqladmin_api::Settings::clear_availability_type ( )
inline

Clears the 'availabilityType' attribute.

◆ clear_backup_configuration()

void google_sqladmin_api::Settings::clear_backup_configuration ( )
inline

Clears the 'backupConfiguration' attribute.

◆ clear_crash_safe_replication_enabled()

void google_sqladmin_api::Settings::clear_crash_safe_replication_enabled ( )
inline

Clears the 'crashSafeReplicationEnabled' attribute.

◆ clear_data_disk_size_gb()

void google_sqladmin_api::Settings::clear_data_disk_size_gb ( )
inline

Clears the 'dataDiskSizeGb' attribute.

◆ clear_data_disk_type()

void google_sqladmin_api::Settings::clear_data_disk_type ( )
inline

Clears the 'dataDiskType' attribute.

◆ clear_database_flags()

void google_sqladmin_api::Settings::clear_database_flags ( )
inline

Clears the 'databaseFlags' attribute.

◆ clear_database_replication_enabled()

void google_sqladmin_api::Settings::clear_database_replication_enabled ( )
inline

Clears the 'databaseReplicationEnabled' attribute.

◆ clear_ip_configuration()

void google_sqladmin_api::Settings::clear_ip_configuration ( )
inline

Clears the 'ipConfiguration' attribute.

◆ clear_kind()

void google_sqladmin_api::Settings::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_location_preference()

void google_sqladmin_api::Settings::clear_location_preference ( )
inline

Clears the 'locationPreference' attribute.

◆ clear_maintenance_window()

void google_sqladmin_api::Settings::clear_maintenance_window ( )
inline

Clears the 'maintenanceWindow' attribute.

◆ clear_pricing_plan()

void google_sqladmin_api::Settings::clear_pricing_plan ( )
inline

Clears the 'pricingPlan' attribute.

◆ clear_replication_type()

void google_sqladmin_api::Settings::clear_replication_type ( )
inline

Clears the 'replicationType' attribute.

◆ clear_settings_version()

void google_sqladmin_api::Settings::clear_settings_version ( )
inline

Clears the 'settingsVersion' attribute.

◆ clear_storage_auto_resize()

void google_sqladmin_api::Settings::clear_storage_auto_resize ( )
inline

Clears the 'storageAutoResize' attribute.

◆ clear_storage_auto_resize_limit()

void google_sqladmin_api::Settings::clear_storage_auto_resize_limit ( )
inline

Clears the 'storageAutoResizeLimit' attribute.

◆ clear_tier()

void google_sqladmin_api::Settings::clear_tier ( )
inline

Clears the 'tier' attribute.

◆ clear_user_labels()

void google_sqladmin_api::Settings::clear_user_labels ( )
inline

Clears the 'userLabels' attribute.

◆ get_activation_policy()

const StringPiece google_sqladmin_api::Settings::get_activation_policy ( ) const
inline

Get the value of the 'activationPolicy' attribute.

◆ get_authorized_gae_applications()

const client::JsonCppArray<string > google_sqladmin_api::Settings::get_authorized_gae_applications ( ) const
inline

Get a reference to the value of the 'authorizedGaeApplications' attribute.

◆ get_availability_type()

const StringPiece google_sqladmin_api::Settings::get_availability_type ( ) const
inline

Get the value of the 'availabilityType' attribute.

◆ get_backup_configuration()

const BackupConfiguration google_sqladmin_api::Settings::get_backup_configuration ( ) const

Get a reference to the value of the 'backupConfiguration' attribute.

◆ get_crash_safe_replication_enabled()

bool google_sqladmin_api::Settings::get_crash_safe_replication_enabled ( ) const
inline

Get the value of the 'crashSafeReplicationEnabled' attribute.

◆ get_data_disk_size_gb()

int64 google_sqladmin_api::Settings::get_data_disk_size_gb ( ) const
inline

Get the value of the 'dataDiskSizeGb' attribute.

◆ get_data_disk_type()

const StringPiece google_sqladmin_api::Settings::get_data_disk_type ( ) const
inline

Get the value of the 'dataDiskType' attribute.

◆ get_database_flags()

const client::JsonCppArray<DatabaseFlags > google_sqladmin_api::Settings::get_database_flags ( ) const

Get a reference to the value of the 'databaseFlags' attribute.

◆ get_database_replication_enabled()

bool google_sqladmin_api::Settings::get_database_replication_enabled ( ) const
inline

Get the value of the 'databaseReplicationEnabled' attribute.

◆ get_ip_configuration()

const IpConfiguration google_sqladmin_api::Settings::get_ip_configuration ( ) const

Get a reference to the value of the 'ipConfiguration' attribute.

◆ get_kind()

const StringPiece google_sqladmin_api::Settings::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_location_preference()

const LocationPreference google_sqladmin_api::Settings::get_location_preference ( ) const

Get a reference to the value of the 'locationPreference' attribute.

◆ get_maintenance_window()

const MaintenanceWindow google_sqladmin_api::Settings::get_maintenance_window ( ) const

Get a reference to the value of the 'maintenanceWindow' attribute.

◆ get_pricing_plan()

const StringPiece google_sqladmin_api::Settings::get_pricing_plan ( ) const
inline

Get the value of the 'pricingPlan' attribute.

◆ get_replication_type()

const StringPiece google_sqladmin_api::Settings::get_replication_type ( ) const
inline

Get the value of the 'replicationType' attribute.

◆ get_settings_version()

int64 google_sqladmin_api::Settings::get_settings_version ( ) const
inline

Get the value of the 'settingsVersion' attribute.

◆ get_storage_auto_resize()

bool google_sqladmin_api::Settings::get_storage_auto_resize ( ) const
inline

Get the value of the 'storageAutoResize' attribute.

◆ get_storage_auto_resize_limit()

int64 google_sqladmin_api::Settings::get_storage_auto_resize_limit ( ) const
inline

Get the value of the 'storageAutoResizeLimit' attribute.

◆ get_tier()

const StringPiece google_sqladmin_api::Settings::get_tier ( ) const
inline

Get the value of the 'tier' attribute.

◆ get_user_labels()

const client::JsonCppAssociativeArray<string > google_sqladmin_api::Settings::get_user_labels ( ) const
inline

Get a reference to the value of the 'userLabels' attribute.

◆ GetTypeName()

const StringPiece google_sqladmin_api::Settings::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_sqladmin_api::Settings

◆ has_activation_policy()

bool google_sqladmin_api::Settings::has_activation_policy ( ) const
inline

Determine if the 'activationPolicy' attribute was set.

Returns
true if the 'activationPolicy' attribute was set.

◆ has_authorized_gae_applications()

bool google_sqladmin_api::Settings::has_authorized_gae_applications ( ) const
inline

Determine if the 'authorizedGaeApplications' attribute was set.

Returns
true if the 'authorizedGaeApplications' attribute was set.

◆ has_availability_type()

bool google_sqladmin_api::Settings::has_availability_type ( ) const
inline

Determine if the 'availabilityType' attribute was set.

Returns
true if the 'availabilityType' attribute was set.

◆ has_backup_configuration()

bool google_sqladmin_api::Settings::has_backup_configuration ( ) const
inline

Determine if the 'backupConfiguration' attribute was set.

Returns
true if the 'backupConfiguration' attribute was set.

◆ has_crash_safe_replication_enabled()

bool google_sqladmin_api::Settings::has_crash_safe_replication_enabled ( ) const
inline

Determine if the 'crashSafeReplicationEnabled' attribute was set.

Returns
true if the 'crashSafeReplicationEnabled' attribute was set.

◆ has_data_disk_size_gb()

bool google_sqladmin_api::Settings::has_data_disk_size_gb ( ) const
inline

Determine if the 'dataDiskSizeGb' attribute was set.

Returns
true if the 'dataDiskSizeGb' attribute was set.

◆ has_data_disk_type()

bool google_sqladmin_api::Settings::has_data_disk_type ( ) const
inline

Determine if the 'dataDiskType' attribute was set.

Returns
true if the 'dataDiskType' attribute was set.

◆ has_database_flags()

bool google_sqladmin_api::Settings::has_database_flags ( ) const
inline

Determine if the 'databaseFlags' attribute was set.

Returns
true if the 'databaseFlags' attribute was set.

◆ has_database_replication_enabled()

bool google_sqladmin_api::Settings::has_database_replication_enabled ( ) const
inline

Determine if the 'databaseReplicationEnabled' attribute was set.

Returns
true if the 'databaseReplicationEnabled' attribute was set.

◆ has_ip_configuration()

bool google_sqladmin_api::Settings::has_ip_configuration ( ) const
inline

Determine if the 'ipConfiguration' attribute was set.

Returns
true if the 'ipConfiguration' attribute was set.

◆ has_kind()

bool google_sqladmin_api::Settings::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_location_preference()

bool google_sqladmin_api::Settings::has_location_preference ( ) const
inline

Determine if the 'locationPreference' attribute was set.

Returns
true if the 'locationPreference' attribute was set.

◆ has_maintenance_window()

bool google_sqladmin_api::Settings::has_maintenance_window ( ) const
inline

Determine if the 'maintenanceWindow' attribute was set.

Returns
true if the 'maintenanceWindow' attribute was set.

◆ has_pricing_plan()

bool google_sqladmin_api::Settings::has_pricing_plan ( ) const
inline

Determine if the 'pricingPlan' attribute was set.

Returns
true if the 'pricingPlan' attribute was set.

◆ has_replication_type()

bool google_sqladmin_api::Settings::has_replication_type ( ) const
inline

Determine if the 'replicationType' attribute was set.

Returns
true if the 'replicationType' attribute was set.

◆ has_settings_version()

bool google_sqladmin_api::Settings::has_settings_version ( ) const
inline

Determine if the 'settingsVersion' attribute was set.

Returns
true if the 'settingsVersion' attribute was set.

◆ has_storage_auto_resize()

bool google_sqladmin_api::Settings::has_storage_auto_resize ( ) const
inline

Determine if the 'storageAutoResize' attribute was set.

Returns
true if the 'storageAutoResize' attribute was set.

◆ has_storage_auto_resize_limit()

bool google_sqladmin_api::Settings::has_storage_auto_resize_limit ( ) const
inline

Determine if the 'storageAutoResizeLimit' attribute was set.

Returns
true if the 'storageAutoResizeLimit' attribute was set.

◆ has_tier()

bool google_sqladmin_api::Settings::has_tier ( ) const
inline

Determine if the 'tier' attribute was set.

Returns
true if the 'tier' attribute was set.

◆ has_user_labels()

bool google_sqladmin_api::Settings::has_user_labels ( ) const
inline

Determine if the 'userLabels' attribute was set.

Returns
true if the 'userLabels' attribute was set.

◆ mutable_authorizedGaeApplications()

client::JsonCppArray<string > google_sqladmin_api::Settings::mutable_authorizedGaeApplications ( )
inline

Gets a reference to a mutable value of the 'authorizedGaeApplications' property.

The App Engine app IDs that can access this instance. First Generation instances only.

Returns
The result can be modified to change the attribute value.

◆ mutable_backupConfiguration()

BackupConfiguration google_sqladmin_api::Settings::mutable_backupConfiguration ( )

Gets a reference to a mutable value of the 'backupConfiguration' property.

The daily backup configuration for the instance.

Returns
The result can be modified to change the attribute value.

◆ mutable_databaseFlags()

client::JsonCppArray<DatabaseFlags > google_sqladmin_api::Settings::mutable_databaseFlags ( )

Gets a reference to a mutable value of the 'databaseFlags' property.

The database flags passed to the instance at startup.

Returns
The result can be modified to change the attribute value.

◆ mutable_ipConfiguration()

IpConfiguration google_sqladmin_api::Settings::mutable_ipConfiguration ( )

Gets a reference to a mutable value of the 'ipConfiguration' property.

The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances.

Returns
The result can be modified to change the attribute value.

◆ mutable_locationPreference()

LocationPreference google_sqladmin_api::Settings::mutable_locationPreference ( )

Gets a reference to a mutable value of the 'locationPreference' property.

The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location is only applicable to First Generation instances.

Returns
The result can be modified to change the attribute value.

◆ mutable_maintenanceWindow()

MaintenanceWindow google_sqladmin_api::Settings::mutable_maintenanceWindow ( )

Gets a reference to a mutable value of the 'maintenanceWindow' property.

The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. Not used for First Generation instances.

Returns
The result can be modified to change the attribute value.

◆ mutable_userLabels()

client::JsonCppAssociativeArray<string > google_sqladmin_api::Settings::mutable_userLabels ( )
inline

Gets a reference to a mutable value of the 'userLabels' property.

User-provided labels, represented as a dictionary where each label is a single key value pair.

Returns
The result can be modified to change the attribute value.

◆ New()

Settings * google_sqladmin_api::Settings::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_activation_policy()

void google_sqladmin_api::Settings::set_activation_policy ( const StringPiece &  value)
inline

Change the 'activationPolicy' attribute.

The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values:

ALWAYS
The instance is on, and remains so even in the absence of connection requests.
NEVER
The instance is off; it is not activated, even if a connection request arrives.
ON_DEMAND
First Generation instances only.

The instance responds to incoming requests, and turns itself off when not in use. Instances with PER_USE pricing turn off after 15 minutes of inactivity. Instances with PER_PACKAGE pricing turn off after 12 hours of inactivity.

Parameters
[in]valueThe new value.

◆ set_availability_type()

void google_sqladmin_api::Settings::set_availability_type ( const StringPiece &  value)
inline

Change the 'availabilityType' attribute.

Availability type (PostgreSQL instances only). Potential values:

ZONAL
The instance serves data from only one zone. Outages in that zone affect data accessibility.
REGIONAL
The instance can serve data from more than one zone in a region (it is highly available).

For more information, see Overview of the High Availability Configuration.

Parameters
[in]valueThe new value.

◆ set_crash_safe_replication_enabled()

void google_sqladmin_api::Settings::set_crash_safe_replication_enabled ( bool  value)
inline

Change the 'crashSafeReplicationEnabled' attribute.

Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property is only applicable to First Generation instances.

Parameters
[in]valueThe new value.

◆ set_data_disk_size_gb()

void google_sqladmin_api::Settings::set_data_disk_size_gb ( int64  value)
inline

Change the 'dataDiskSizeGb' attribute.

The size of data disk, in GB. The data disk size minimum is 10GB. Not used for First Generation instances.

Parameters
[in]valueThe new value.

◆ set_data_disk_type()

void google_sqladmin_api::Settings::set_data_disk_type ( const StringPiece &  value)
inline

Change the 'dataDiskType' attribute.

The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.

Parameters
[in]valueThe new value.

◆ set_database_replication_enabled()

void google_sqladmin_api::Settings::set_database_replication_enabled ( bool  value)
inline

Change the 'databaseReplicationEnabled' attribute.

Configuration specific to read replica instances. Indicates whether replication is enabled or not.

Parameters
[in]valueThe new value.

◆ set_kind()

void google_sqladmin_api::Settings::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

This is always sql::settings.

Parameters
[in]valueThe new value.

◆ set_pricing_plan()

void google_sqladmin_api::Settings::set_pricing_plan ( const StringPiece &  value)
inline

Change the 'pricingPlan' attribute.

The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances.

Parameters
[in]valueThe new value.

◆ set_replication_type()

void google_sqladmin_api::Settings::set_replication_type ( const StringPiece &  value)
inline

Change the 'replicationType' attribute.

The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. This property is only applicable to First Generation instances.

Parameters
[in]valueThe new value.

◆ set_settings_version()

void google_sqladmin_api::Settings::set_settings_version ( int64  value)
inline

Change the 'settingsVersion' attribute.

The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.

Parameters
[in]valueThe new value.

◆ set_storage_auto_resize()

void google_sqladmin_api::Settings::set_storage_auto_resize ( bool  value)
inline

Change the 'storageAutoResize' attribute.

Configuration to increase storage size automatically. The default value is true. Not used for First Generation instances.

Parameters
[in]valueThe new value.

◆ set_storage_auto_resize_limit()

void google_sqladmin_api::Settings::set_storage_auto_resize_limit ( int64  value)
inline

Change the 'storageAutoResizeLimit' attribute.

The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. Not used for First Generation instances.

Parameters
[in]valueThe new value.

◆ set_tier()

void google_sqladmin_api::Settings::set_tier ( const StringPiece &  value)
inline

Change the 'tier' attribute.

The tier (or machine type) for this instance, for example db-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL instances). For MySQL instances, this property determines whether the instance is First or Second Generation. For more information, see Instance Settings.

Parameters
[in]valueThe new value.

The documentation for this class was generated from the following files: