Blame - docs/dyn/sqladmin_v1beta3.instances.html - platform/external/python/google-api-python-client

blob: 1d1c60985a5cce8a53ca37753d0f7547ab5fcb0c [file] [log] [blame]

John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="sqladmin_v1beta3.html">Cloud SQL Administration API</a> . <a href="sqladmin_v1beta3.instances.html">instances</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#clone">clone(project, body)</a></code></p>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	79	<p class="firstline">Creates a Cloud SQL instance as a clone of a source instance.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	80	<p class="toc_element">
				81	<code><a href="#delete">delete(project, instance)</a></code></p>
				82	<p class="firstline">Deletes a Cloud SQL instance.</p>
				83	<p class="toc_element">
				84	<code><a href="#export">export(project, instance, body)</a></code></p>
				85	<p class="firstline">Exports data from a Cloud SQL instance to a Google Cloud Storage bucket as a MySQL dump file.</p>
				86	<p class="toc_element">
				87	<code><a href="#get">get(project, instance)</a></code></p>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	88	<p class="firstline">Retrieves information about a Cloud SQL instance.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	89	<p class="toc_element">
				90	<code><a href="#import_">import_(project, instance, body)</a></code></p>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	91	<p class="firstline">Imports data into a Cloud SQL instance from a MySQL dump file stored in a Google Cloud Storage bucket.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	92	<p class="toc_element">
				93	<code><a href="#insert">insert(project, body)</a></code></p>
				94	<p class="firstline">Creates a new Cloud SQL instance.</p>
				95	<p class="toc_element">
				96	<code><a href="#list">list(project, pageToken=None, maxResults=None)</a></code></p>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	97	<p class="firstline">Lists instances for a given project, in alphabetical order by instance name.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	98	<p class="toc_element">
				99	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				100	<p class="firstline">Retrieves the next page of results.</p>
				101	<p class="toc_element">
				102	<code><a href="#patch">patch(project, instance, body)</a></code></p>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	103	<p class="firstline">Updates the settings of a Cloud SQL instance. This method supports patch semantics.</p>
				104	<p class="toc_element">
				105	<code><a href="#promoteReplica">promoteReplica(project, instance)</a></code></p>
				106	<p class="firstline">Promotes the read replica instance to be a stand-alone Cloud SQL instance.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	107	<p class="toc_element">
				108	<code><a href="#resetSslConfig">resetSslConfig(project, instance)</a></code></p>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	109	<p class="firstline">Deletes all client certificates and generates a new server SSL certificate for a Cloud SQL instance.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	110	<p class="toc_element">
				111	<code><a href="#restart">restart(project, instance)</a></code></p>
				112	<p class="firstline">Restarts a Cloud SQL instance.</p>
				113	<p class="toc_element">
				114	<code><a href="#restoreBackup">restoreBackup(project, instance, backupConfiguration, dueTime)</a></code></p>
				115	<p class="firstline">Restores a backup of a Cloud SQL instance.</p>
				116	<p class="toc_element">
				117	<code><a href="#setRootPassword">setRootPassword(project, instance, body)</a></code></p>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	118	<p class="firstline">Sets the password for the root user of the specified Cloud SQL instance.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	119	<p class="toc_element">
				120	<code><a href="#update">update(project, instance, body)</a></code></p>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	121	<p class="firstline">Updates the settings of a Cloud SQL instance.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	122	<h3>Method Details</h3>
				123	<div class="method">
				124	<code class="details" id="clone">clone(project, body)</code>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	125	<pre>Creates a Cloud SQL instance as a clone of a source instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	126
				127	Args:
				128	project: string, Project ID of the source as well as the clone Cloud SQL instance. (required)
				129	body: object, The request body. (required)
				130	The object takes the form of:
				131
				132	{ # Database instance clone request.
				133	"cloneContext": { # Database instance clone context. # Contains details about the clone operation.
				134	"sourceInstanceName": "A String", # Name of the Cloud SQL instance to be cloned.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	135	"binLogCoordinates": { # Binary log coordinates. # Binary log coordinates, if specified, indentify the position up to which the source instance should be cloned. If not specified, the source instance is cloned up to the most recent binary log coordinates.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	136	"binLogPosition": "A String", # Position (offset) within the binary log file.
				137	"kind": "sql#binLogCoordinates", # This is always sql#binLogCoordinates.
				138	"binLogFileName": "A String", # Name of the binary log file for a Cloud SQL instance.
				139	},
				140	"kind": "sql#cloneContext", # This is always sql#cloneContext.
				141	"destinationInstanceName": "A String", # Name of the Cloud SQL instance to be created as a clone.
				142	},
				143	}
				144
				145
				146	Returns:
				147	An object of the form:
				148
				149	{ # Database instance clone response.
				150	"kind": "sql#instancesClone", # This is always sql#instancesClone.
				151	"operation": "A String", # An unique identifier for the operation associated with the cloned instance. You can use this identifier to retrieve the Operations resource, which has information about the operation.
				152	}</pre>
				153	</div>
				154
				155	<div class="method">
				156	<code class="details" id="delete">delete(project, instance)</code>
				157	<pre>Deletes a Cloud SQL instance.
				158
				159	Args:
				160	project: string, Project ID of the project that contains the instance to be deleted. (required)
				161	instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
				162
				163	Returns:
				164	An object of the form:
				165
				166	{ # Database instance delete response.
				167	"kind": "sql#instancesDelete", # This is always sql#instancesDelete.
				168	"operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
				169	}</pre>
				170	</div>
				171
				172	<div class="method">
				173	<code class="details" id="export">export(project, instance, body)</code>
				174	<pre>Exports data from a Cloud SQL instance to a Google Cloud Storage bucket as a MySQL dump file.
				175
				176	Args:
				177	project: string, Project ID of the project that contains the instance to be exported. (required)
				178	instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
				179	body: object, The request body. (required)
				180	The object takes the form of:
				181
				182	{ # Database instance export request.
				183	"exportContext": { # Database instance export context. # Contains details about the export operation.
				184	"table": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
				185	"A String",
				186	],
				187	"kind": "sql#exportContext", # This is always sql#exportContext.
				188	"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored, or where it was already stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If the filename ends with .gz, the contents are compressed.
				189	"database": [ # Databases (for example, guestbook) from which the export is made. If unspecified, all databases are exported.
				190	"A String",
				191	],
				192	},
				193	}
				194
				195
				196	Returns:
				197	An object of the form:
				198
				199	{ # Database instance export response.
				200	"kind": "sql#instancesExport", # This is always sql#instancesExport.
				201	"operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
				202	}</pre>
				203	</div>
				204
				205	<div class="method">
				206	<code class="details" id="get">get(project, instance)</code>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	207	<pre>Retrieves information about a Cloud SQL instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	208
				209	Args:
				210	project: string, Project ID of the project that contains the instance. (required)
				211	instance: string, Database instance ID. This does not include the project ID. (required)
				212
				213	Returns:
				214	An object of the form:
				215
				216	{ # A Cloud SQL instance resource.
				217	"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
				218	"kind": "sql#instance", # This is always sql#instance.
				219	"maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	220	"ipv6Address": "A String", # The IPv6 address assigned to the instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	221	"serverCaCert": { # SslCerts Resource # SSL configuration.
				222	"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
				223	"kind": "sql#sslCert", # This is always sql#sslCert.
				224	"sha1Fingerprint": "A String", # Sha1 Fingerprint.
				225	"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
				226	"instance": "A String", # Name of the database instance.
				227	"cert": "A String", # PEM representation.
				228	"expirationTime": "A String", # Time when the certificate expires.
				229	"createTime": "A String", # Time when the certificate was created.
				230	},
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	231	"replicaNames": [ # The replicas of the instance.
				232	"A String",
				233	],
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	234	"region": "A String", # The geographical region. Can be us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	235	"settings": { # Database instance settings. # The user settings.
				236	"databaseFlags": [ # The database flags passed to the instance at startup.
				237	{ # MySQL flags for Cloud SQL instances.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	238	"name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.
				239	"value": "A String", # The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	240	},
				241	],
				242	"kind": "sql#settings", # This is always sql#settings.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	243	"authorizedGaeApplications": [ # The App Engine app IDs that can access this instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	244	"A String",
				245	],
				246	"activationPolicy": "A String", # The activation policy for this instance. This specifies when the instance should be activated and is applicable only when the instance state is RUNNABLE. This can be one of the following.
				247	# ALWAYS: The instance should always be active.
				248	# NEVER: The instance should never be activated.
				249	# ON_DEMAND: The instance is activated upon receiving requests.
				250	"backupConfiguration": [ # The daily backup configuration for the instance.
				251	{ # Database instance backup configuration.
				252	"startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
				253	"kind": "sql#backupConfiguration", # This is always sql#backupConfiguration.
				254	"enabled": True or False, # Whether this configuration is enabled.
				255	"id": "A String", # Identifier for this configuration. This gets generated automatically when a backup configuration is created.
				256	"binaryLogEnabled": True or False, # Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.
				257	},
				258	],
				259	"ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance.
				260	"enabled": True or False, # Whether the instance should be assigned an IP address or not.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	261	"kind": "sql#ipConfiguration", # This is always sql#ipConfiguration.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	262	"requireSsl": True or False, # Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
				263	"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
				264	"A String",
				265	],
				266	},
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	267	"databaseReplicationEnabled": True or False, # Configuration specific to read replica instance. Indicates whether replication is enabled or not.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	268	"replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.
				269	"tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	270	"pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	271	"settingsVersion": "A String", # 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.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	272	"locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	273	"kind": "sql#locationPreference", # This is always sql#locationPreference.
				274	"zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	275	"followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	276	},
				277	},
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	278	"masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	279	"currentDiskSize": "A String", # The current disk usage of the instance in bytes.
				280	"instance": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
				281	"state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following.
				282	# RUNNABLE: The instance is running, or is ready to run when accessed.
				283	# SUSPENDED: The instance is not available, for example due to problems with billing.
				284	# PENDING_CREATE: The instance is being created.
				285	# MAINTENANCE: The instance is down for maintenance.
				286	# UNKNOWN_STATE: The state of the instance is unknown.
				287	"etag": "A String", # HTTP 1.1 Entity tag for the resource.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	288	"serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	289	"ipAddresses": [ # The assigned IP addresses for the instance.
				290	{ # Database instance IP Mapping.
				291	"timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
				292	"ipAddress": "A String", # The IP address assigned.
				293	},
				294	],
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	295	"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	296	"databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion cannot be changed after instance creation.
				297	"instanceType": "A String", # The instance type. This can be one of the following.
				298	# CLOUD_SQL_INSTANCE: Regular Cloud SQL instance.
				299	# READ_REPLICA_INSTANCE: Cloud SQL instance acting as a read-replica.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	300	}</pre>
				301	</div>
				302
				303	<div class="method">
				304	<code class="details" id="import_">import_(project, instance, body)</code>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	305	<pre>Imports data into a Cloud SQL instance from a MySQL dump file stored in a Google Cloud Storage bucket.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	306
				307	Args:
				308	project: string, Project ID of the project that contains the instance. (required)
				309	instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
				310	body: object, The request body. (required)
				311	The object takes the form of:
				312
				313	{ # Database instance import request.
				314	"importContext": { # Database instance import context. # Contains details about the import operation.
				315	"kind": "sql#importContext", # This is always sql#importContext.
				316	"uri": [ # A path to the MySQL dump file in Google Cloud Storage from which the import is made. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported.
				317	"A String",
				318	],
				319	"database": "A String", # The database (for example, guestbook) to which the import is made. If not set, it is assumed that the database is specified in the file to be imported.
				320	},
				321	}
				322
				323
				324	Returns:
				325	An object of the form:
				326
				327	{ # Database instance import response.
				328	"kind": "sql#instancesImport", # This is always sql#instancesImport.
				329	"operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
				330	}</pre>
				331	</div>
				332
				333	<div class="method">
				334	<code class="details" id="insert">insert(project, body)</code>
				335	<pre>Creates a new Cloud SQL instance.
				336
				337	Args:
				338	project: string, Project ID of the project to which the newly created Cloud SQL instances should belong. (required)
				339	body: object, The request body. (required)
				340	The object takes the form of:
				341
				342	{ # A Cloud SQL instance resource.
				343	"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
				344	"kind": "sql#instance", # This is always sql#instance.
				345	"maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	346	"ipv6Address": "A String", # The IPv6 address assigned to the instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	347	"serverCaCert": { # SslCerts Resource # SSL configuration.
				348	"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
				349	"kind": "sql#sslCert", # This is always sql#sslCert.
				350	"sha1Fingerprint": "A String", # Sha1 Fingerprint.
				351	"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
				352	"instance": "A String", # Name of the database instance.
				353	"cert": "A String", # PEM representation.
				354	"expirationTime": "A String", # Time when the certificate expires.
				355	"createTime": "A String", # Time when the certificate was created.
				356	},
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	357	"replicaNames": [ # The replicas of the instance.
				358	"A String",
				359	],
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	360	"region": "A String", # The geographical region. Can be us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	361	"settings": { # Database instance settings. # The user settings.
				362	"databaseFlags": [ # The database flags passed to the instance at startup.
				363	{ # MySQL flags for Cloud SQL instances.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	364	"name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.
				365	"value": "A String", # The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	366	},
				367	],
				368	"kind": "sql#settings", # This is always sql#settings.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	369	"authorizedGaeApplications": [ # The App Engine app IDs that can access this instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	370	"A String",
				371	],
				372	"activationPolicy": "A String", # The activation policy for this instance. This specifies when the instance should be activated and is applicable only when the instance state is RUNNABLE. This can be one of the following.
				373	# ALWAYS: The instance should always be active.
				374	# NEVER: The instance should never be activated.
				375	# ON_DEMAND: The instance is activated upon receiving requests.
				376	"backupConfiguration": [ # The daily backup configuration for the instance.
				377	{ # Database instance backup configuration.
				378	"startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
				379	"kind": "sql#backupConfiguration", # This is always sql#backupConfiguration.
				380	"enabled": True or False, # Whether this configuration is enabled.
				381	"id": "A String", # Identifier for this configuration. This gets generated automatically when a backup configuration is created.
				382	"binaryLogEnabled": True or False, # Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.
				383	},
				384	],
				385	"ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance.
				386	"enabled": True or False, # Whether the instance should be assigned an IP address or not.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	387	"kind": "sql#ipConfiguration", # This is always sql#ipConfiguration.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	388	"requireSsl": True or False, # Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
				389	"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
				390	"A String",
				391	],
				392	},
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	393	"databaseReplicationEnabled": True or False, # Configuration specific to read replica instance. Indicates whether replication is enabled or not.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	394	"replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.
				395	"tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	396	"pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	397	"settingsVersion": "A String", # 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.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	398	"locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	399	"kind": "sql#locationPreference", # This is always sql#locationPreference.
				400	"zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	401	"followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	402	},
				403	},
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	404	"masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	405	"currentDiskSize": "A String", # The current disk usage of the instance in bytes.
				406	"instance": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
				407	"state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following.
				408	# RUNNABLE: The instance is running, or is ready to run when accessed.
				409	# SUSPENDED: The instance is not available, for example due to problems with billing.
				410	# PENDING_CREATE: The instance is being created.
				411	# MAINTENANCE: The instance is down for maintenance.
				412	# UNKNOWN_STATE: The state of the instance is unknown.
				413	"etag": "A String", # HTTP 1.1 Entity tag for the resource.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	414	"serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	415	"ipAddresses": [ # The assigned IP addresses for the instance.
				416	{ # Database instance IP Mapping.
				417	"timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
				418	"ipAddress": "A String", # The IP address assigned.
				419	},
				420	],
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	421	"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	422	"databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion cannot be changed after instance creation.
				423	"instanceType": "A String", # The instance type. This can be one of the following.
				424	# CLOUD_SQL_INSTANCE: Regular Cloud SQL instance.
				425	# READ_REPLICA_INSTANCE: Cloud SQL instance acting as a read-replica.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	426	}
				427
				428
				429	Returns:
				430	An object of the form:
				431
				432	{ # Database instance insert response.
				433	"kind": "sql#instancesInsert", # This is always sql#instancesInsert.
				434	"operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
				435	}</pre>
				436	</div>
				437
				438	<div class="method">
				439	<code class="details" id="list">list(project, pageToken=None, maxResults=None)</code>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	440	<pre>Lists instances for a given project, in alphabetical order by instance name.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	441
				442	Args:
				443	project: string, Project ID of the project for which to list Cloud SQL instances. (required)
				444	pageToken: string, A previously-returned page token representing part of the larger set of results to view.
				445	maxResults: integer, The maximum number of results to return per response.
				446
				447	Returns:
				448	An object of the form:
				449
				450	{ # Database instances list response.
				451	"nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
				452	"items": [ # List of database instance resources.
				453	{ # A Cloud SQL instance resource.
				454	"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
				455	"kind": "sql#instance", # This is always sql#instance.
				456	"maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	457	"ipv6Address": "A String", # The IPv6 address assigned to the instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	458	"serverCaCert": { # SslCerts Resource # SSL configuration.
				459	"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
				460	"kind": "sql#sslCert", # This is always sql#sslCert.
				461	"sha1Fingerprint": "A String", # Sha1 Fingerprint.
				462	"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
				463	"instance": "A String", # Name of the database instance.
				464	"cert": "A String", # PEM representation.
				465	"expirationTime": "A String", # Time when the certificate expires.
				466	"createTime": "A String", # Time when the certificate was created.
				467	},
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	468	"replicaNames": [ # The replicas of the instance.
				469	"A String",
				470	],
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	471	"region": "A String", # The geographical region. Can be us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	472	"settings": { # Database instance settings. # The user settings.
				473	"databaseFlags": [ # The database flags passed to the instance at startup.
				474	{ # MySQL flags for Cloud SQL instances.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	475	"name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.
				476	"value": "A String", # The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	477	},
				478	],
				479	"kind": "sql#settings", # This is always sql#settings.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	480	"authorizedGaeApplications": [ # The App Engine app IDs that can access this instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	481	"A String",
				482	],
				483	"activationPolicy": "A String", # The activation policy for this instance. This specifies when the instance should be activated and is applicable only when the instance state is RUNNABLE. This can be one of the following.
				484	# ALWAYS: The instance should always be active.
				485	# NEVER: The instance should never be activated.
				486	# ON_DEMAND: The instance is activated upon receiving requests.
				487	"backupConfiguration": [ # The daily backup configuration for the instance.
				488	{ # Database instance backup configuration.
				489	"startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
				490	"kind": "sql#backupConfiguration", # This is always sql#backupConfiguration.
				491	"enabled": True or False, # Whether this configuration is enabled.
				492	"id": "A String", # Identifier for this configuration. This gets generated automatically when a backup configuration is created.
				493	"binaryLogEnabled": True or False, # Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.
				494	},
				495	],
				496	"ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance.
				497	"enabled": True or False, # Whether the instance should be assigned an IP address or not.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	498	"kind": "sql#ipConfiguration", # This is always sql#ipConfiguration.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	499	"requireSsl": True or False, # Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
				500	"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
				501	"A String",
				502	],
				503	},
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	504	"databaseReplicationEnabled": True or False, # Configuration specific to read replica instance. Indicates whether replication is enabled or not.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	505	"replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.
				506	"tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	507	"pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	508	"settingsVersion": "A String", # 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.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	509	"locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	510	"kind": "sql#locationPreference", # This is always sql#locationPreference.
				511	"zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	512	"followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	513	},
				514	},
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	515	"masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	516	"currentDiskSize": "A String", # The current disk usage of the instance in bytes.
				517	"instance": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
				518	"state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following.
				519	# RUNNABLE: The instance is running, or is ready to run when accessed.
				520	# SUSPENDED: The instance is not available, for example due to problems with billing.
				521	# PENDING_CREATE: The instance is being created.
				522	# MAINTENANCE: The instance is down for maintenance.
				523	# UNKNOWN_STATE: The state of the instance is unknown.
				524	"etag": "A String", # HTTP 1.1 Entity tag for the resource.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	525	"serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	526	"ipAddresses": [ # The assigned IP addresses for the instance.
				527	{ # Database instance IP Mapping.
				528	"timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
				529	"ipAddress": "A String", # The IP address assigned.
				530	},
				531	],
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	532	"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	533	"databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion cannot be changed after instance creation.
				534	"instanceType": "A String", # The instance type. This can be one of the following.
				535	# CLOUD_SQL_INSTANCE: Regular Cloud SQL instance.
				536	# READ_REPLICA_INSTANCE: Cloud SQL instance acting as a read-replica.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	537	},
				538	],
				539	"kind": "sql#instancesList", # This is always sql#instancesList.
				540	}</pre>
				541	</div>
				542
				543	<div class="method">
				544	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				545	<pre>Retrieves the next page of results.
				546
				547	Args:
				548	previous_request: The request for the previous page. (required)
				549	previous_response: The response from the request for the previous page. (required)
				550
				551	Returns:
				552	A request object that you can call 'execute()' on to request the next
				553	page. Returns None if there are no more items in the collection.
				554	</pre>
				555	</div>
				556
				557	<div class="method">
				558	<code class="details" id="patch">patch(project, instance, body)</code>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	559	<pre>Updates the settings of a Cloud SQL instance. This method supports patch semantics.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	560
				561	Args:
				562	project: string, Project ID of the project that contains the instance. (required)
				563	instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
				564	body: object, The request body. (required)
				565	The object takes the form of:
				566
				567	{ # A Cloud SQL instance resource.
				568	"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
				569	"kind": "sql#instance", # This is always sql#instance.
				570	"maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	571	"ipv6Address": "A String", # The IPv6 address assigned to the instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	572	"serverCaCert": { # SslCerts Resource # SSL configuration.
				573	"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
				574	"kind": "sql#sslCert", # This is always sql#sslCert.
				575	"sha1Fingerprint": "A String", # Sha1 Fingerprint.
				576	"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
				577	"instance": "A String", # Name of the database instance.
				578	"cert": "A String", # PEM representation.
				579	"expirationTime": "A String", # Time when the certificate expires.
				580	"createTime": "A String", # Time when the certificate was created.
				581	},
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	582	"replicaNames": [ # The replicas of the instance.
				583	"A String",
				584	],
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	585	"region": "A String", # The geographical region. Can be us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	586	"settings": { # Database instance settings. # The user settings.
				587	"databaseFlags": [ # The database flags passed to the instance at startup.
				588	{ # MySQL flags for Cloud SQL instances.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	589	"name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.
				590	"value": "A String", # The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	591	},
				592	],
				593	"kind": "sql#settings", # This is always sql#settings.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	594	"authorizedGaeApplications": [ # The App Engine app IDs that can access this instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	595	"A String",
				596	],
				597	"activationPolicy": "A String", # The activation policy for this instance. This specifies when the instance should be activated and is applicable only when the instance state is RUNNABLE. This can be one of the following.
				598	# ALWAYS: The instance should always be active.
				599	# NEVER: The instance should never be activated.
				600	# ON_DEMAND: The instance is activated upon receiving requests.
				601	"backupConfiguration": [ # The daily backup configuration for the instance.
				602	{ # Database instance backup configuration.
				603	"startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
				604	"kind": "sql#backupConfiguration", # This is always sql#backupConfiguration.
				605	"enabled": True or False, # Whether this configuration is enabled.
				606	"id": "A String", # Identifier for this configuration. This gets generated automatically when a backup configuration is created.
				607	"binaryLogEnabled": True or False, # Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.
				608	},
				609	],
				610	"ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance.
				611	"enabled": True or False, # Whether the instance should be assigned an IP address or not.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	612	"kind": "sql#ipConfiguration", # This is always sql#ipConfiguration.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	613	"requireSsl": True or False, # Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
				614	"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
				615	"A String",
				616	],
				617	},
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	618	"databaseReplicationEnabled": True or False, # Configuration specific to read replica instance. Indicates whether replication is enabled or not.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	619	"replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.
				620	"tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	621	"pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	622	"settingsVersion": "A String", # 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.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	623	"locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	624	"kind": "sql#locationPreference", # This is always sql#locationPreference.
				625	"zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	626	"followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	627	},
				628	},
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	629	"masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	630	"currentDiskSize": "A String", # The current disk usage of the instance in bytes.
				631	"instance": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
				632	"state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following.
				633	# RUNNABLE: The instance is running, or is ready to run when accessed.
				634	# SUSPENDED: The instance is not available, for example due to problems with billing.
				635	# PENDING_CREATE: The instance is being created.
				636	# MAINTENANCE: The instance is down for maintenance.
				637	# UNKNOWN_STATE: The state of the instance is unknown.
				638	"etag": "A String", # HTTP 1.1 Entity tag for the resource.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	639	"serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	640	"ipAddresses": [ # The assigned IP addresses for the instance.
				641	{ # Database instance IP Mapping.
				642	"timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
				643	"ipAddress": "A String", # The IP address assigned.
				644	},
				645	],
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	646	"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	647	"databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion cannot be changed after instance creation.
				648	"instanceType": "A String", # The instance type. This can be one of the following.
				649	# CLOUD_SQL_INSTANCE: Regular Cloud SQL instance.
				650	# READ_REPLICA_INSTANCE: Cloud SQL instance acting as a read-replica.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	651	}
				652
				653
				654	Returns:
				655	An object of the form:
				656
				657	{ # Database instance update response.
				658	"kind": "sql#instancesUpdate", # This is always sql#instancesUpdate.
				659	"operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve information about the operation.
				660	}</pre>
				661	</div>
				662
				663	<div class="method">
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	664	<code class="details" id="promoteReplica">promoteReplica(project, instance)</code>
				665	<pre>Promotes the read replica instance to be a stand-alone Cloud SQL instance.
				666
				667	Args:
				668	project: string, ID of the project that contains the read replica. (required)
				669	instance: string, Cloud SQL read replica instance name. (required)
				670
				671	Returns:
				672	An object of the form:
				673
				674	{ # Database promote read replica response.
				675	"kind": "sql#instancesPromoteReplica", # This is always sql#instancesPromoteReplica.
				676	"operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
				677	}</pre>
				678	</div>
				679
				680	<div class="method">
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	681	<code class="details" id="resetSslConfig">resetSslConfig(project, instance)</code>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	682	<pre>Deletes all client certificates and generates a new server SSL certificate for a Cloud SQL instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	683
				684	Args:
				685	project: string, Project ID of the project that contains the instance. (required)
				686	instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
				687
				688	Returns:
				689	An object of the form:
				690
				691	{ # Database instance resetSslConfig response.
				692	"kind": "sql#instancesResetSslConfig", # This is always sql#instancesResetSslConfig.
				693	"operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. All ssl client certificates will be deleted and a new server certificate will be created. Does not take effect until the next instance restart.
				694	}</pre>
				695	</div>
				696
				697	<div class="method">
				698	<code class="details" id="restart">restart(project, instance)</code>
				699	<pre>Restarts a Cloud SQL instance.
				700
				701	Args:
				702	project: string, Project ID of the project that contains the instance to be restarted. (required)
				703	instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
				704
				705	Returns:
				706	An object of the form:
				707
				708	{ # Database instance restart response.
				709	"kind": "sql#instancesRestart", # This is always sql#instancesRestart.
				710	"operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
				711	}</pre>
				712	</div>
				713
				714	<div class="method">
				715	<code class="details" id="restoreBackup">restoreBackup(project, instance, backupConfiguration, dueTime)</code>
				716	<pre>Restores a backup of a Cloud SQL instance.
				717
				718	Args:
				719	project: string, Project ID of the project that contains the instance. (required)
				720	instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
				721	backupConfiguration: string, The identifier of the backup configuration. This gets generated automatically when a backup configuration is created. (required)
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	722	dueTime: string, The start time of the four-hour backup window. The backup can occur any time in the window. The time is in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	723
				724	Returns:
				725	An object of the form:
				726
				727	{ # Database instance restore backup response.
				728	"kind": "sql#instancesRestoreBackup", # This is always sql#instancesRestoreBackup.
				729	"operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
				730	}</pre>
				731	</div>
				732
				733	<div class="method">
				734	<code class="details" id="setRootPassword">setRootPassword(project, instance, body)</code>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	735	<pre>Sets the password for the root user of the specified Cloud SQL instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	736
				737	Args:
				738	project: string, Project ID of the project that contains the instance. (required)
				739	instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
				740	body: object, The request body. (required)
				741	The object takes the form of:
				742
				743	{ # Database instance set root password request.
				744	"setRootPasswordContext": { # Database instance set root password context. # Set Root Password Context.
				745	"kind": "sql#setRootUserContext", # This is always sql#setRootUserContext.
				746	"password": "A String", # The password for the root user.
				747	},
				748	}
				749
				750
				751	Returns:
				752	An object of the form:
				753
				754	{ # Database instance set root password response.
				755	"kind": "sql#instancesSetRootPassword", # This is always sql#instancesSetRootPassword.
				756	"operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
				757	}</pre>
				758	</div>
				759
				760	<div class="method">
				761	<code class="details" id="update">update(project, instance, body)</code>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	762	<pre>Updates the settings of a Cloud SQL instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	763
				764	Args:
				765	project: string, Project ID of the project that contains the instance. (required)
				766	instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
				767	body: object, The request body. (required)
				768	The object takes the form of:
				769
				770	{ # A Cloud SQL instance resource.
				771	"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
				772	"kind": "sql#instance", # This is always sql#instance.
				773	"maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	774	"ipv6Address": "A String", # The IPv6 address assigned to the instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	775	"serverCaCert": { # SslCerts Resource # SSL configuration.
				776	"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
				777	"kind": "sql#sslCert", # This is always sql#sslCert.
				778	"sha1Fingerprint": "A String", # Sha1 Fingerprint.
				779	"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
				780	"instance": "A String", # Name of the database instance.
				781	"cert": "A String", # PEM representation.
				782	"expirationTime": "A String", # Time when the certificate expires.
				783	"createTime": "A String", # Time when the certificate was created.
				784	},
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	785	"replicaNames": [ # The replicas of the instance.
				786	"A String",
				787	],
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	788	"region": "A String", # The geographical region. Can be us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	789	"settings": { # Database instance settings. # The user settings.
				790	"databaseFlags": [ # The database flags passed to the instance at startup.
				791	{ # MySQL flags for Cloud SQL instances.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	792	"name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.
				793	"value": "A String", # The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	794	},
				795	],
				796	"kind": "sql#settings", # This is always sql#settings.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	797	"authorizedGaeApplications": [ # The App Engine app IDs that can access this instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	798	"A String",
				799	],
				800	"activationPolicy": "A String", # The activation policy for this instance. This specifies when the instance should be activated and is applicable only when the instance state is RUNNABLE. This can be one of the following.
				801	# ALWAYS: The instance should always be active.
				802	# NEVER: The instance should never be activated.
				803	# ON_DEMAND: The instance is activated upon receiving requests.
				804	"backupConfiguration": [ # The daily backup configuration for the instance.
				805	{ # Database instance backup configuration.
				806	"startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
				807	"kind": "sql#backupConfiguration", # This is always sql#backupConfiguration.
				808	"enabled": True or False, # Whether this configuration is enabled.
				809	"id": "A String", # Identifier for this configuration. This gets generated automatically when a backup configuration is created.
				810	"binaryLogEnabled": True or False, # Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.
				811	},
				812	],
				813	"ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance.
				814	"enabled": True or False, # Whether the instance should be assigned an IP address or not.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	815	"kind": "sql#ipConfiguration", # This is always sql#ipConfiguration.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	816	"requireSsl": True or False, # Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
				817	"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
				818	"A String",
				819	],
				820	},
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	821	"databaseReplicationEnabled": True or False, # Configuration specific to read replica instance. Indicates whether replication is enabled or not.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	822	"replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.
				823	"tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	824	"pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	825	"settingsVersion": "A String", # 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.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	826	"locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	827	"kind": "sql#locationPreference", # This is always sql#locationPreference.
				828	"zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	829	"followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	830	},
				831	},
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	832	"masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	833	"currentDiskSize": "A String", # The current disk usage of the instance in bytes.
				834	"instance": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
				835	"state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following.
				836	# RUNNABLE: The instance is running, or is ready to run when accessed.
				837	# SUSPENDED: The instance is not available, for example due to problems with billing.
				838	# PENDING_CREATE: The instance is being created.
				839	# MAINTENANCE: The instance is down for maintenance.
				840	# UNKNOWN_STATE: The state of the instance is unknown.
				841	"etag": "A String", # HTTP 1.1 Entity tag for the resource.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	842	"serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	843	"ipAddresses": [ # The assigned IP addresses for the instance.
				844	{ # Database instance IP Mapping.
				845	"timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
				846	"ipAddress": "A String", # The IP address assigned.
				847	},
				848	],
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	849	"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	850	"databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion cannot be changed after instance creation.
				851	"instanceType": "A String", # The instance type. This can be one of the following.
				852	# CLOUD_SQL_INSTANCE: Regular Cloud SQL instance.
				853	# READ_REPLICA_INSTANCE: Cloud SQL instance acting as a read-replica.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	854	}
				855
				856
				857	Returns:
				858	An object of the form:
				859
				860	{ # Database instance update response.
				861	"kind": "sql#instancesUpdate", # This is always sql#instancesUpdate.
				862	"operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve information about the operation.
				863	}</pre>
				864	</div>
				865
				866	</body></html>