blob: 592d9b880b9c6cd36990a762823ad9f72906d06e [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -08001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070075<h1><a href="sqladmin_v1beta4.html">Cloud SQL Admin API</a> . <a href="sqladmin_v1beta4.flags.html">flags</a></h1>
Craig Citroe633be12015-03-02 13:40:36 -080076<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040078 <code><a href="#list">list(databaseVersion=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070079<p class="firstline">List all available database flags for Cloud SQL instances.</p>
Craig Citroe633be12015-03-02 13:40:36 -080080<h3>Method Details</h3>
81<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040082 <code class="details" id="list">list(databaseVersion=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070083 <pre>List all available database flags for Cloud SQL instances.
Craig Citroe633be12015-03-02 13:40:36 -080084
85Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070086 databaseVersion: string, Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions.
Craig Citroe633be12015-03-02 13:40:36 -080087
88Returns:
89 An object of the form:
90
91 { # Flags list response.
92 "items": [ # List of flags.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070093 { # A flag resource.
94 "inBeta": True or False, # True if the flag is only released in Beta.
Craig Citroe633be12015-03-02 13:40:36 -080095 "kind": "sql#flag", # This is always sql#flag.
96 "name": "A String", # This is the name of the flag. Flag names always use underscores, not hyphens, e.g. max_allowed_packet
97 "allowedStringValues": [ # For STRING flags, a list of strings that the value can be set to.
98 "A String",
99 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800100 "requiresRestart": True or False, # Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700101 "appliesTo": [ # The database version this flag applies to. Can be MYSQL_5_5, MYSQL_5_6, or MYSQL_5_7. MYSQL_5_7 is applicable only to Second Generation instances.
Craig Citroe633be12015-03-02 13:40:36 -0800102 "A String",
103 ],
104 "maxValue": "A String", # For INTEGER flags, the maximum allowed value.
105 "minValue": "A String", # For INTEGER flags, the minimum allowed value.
106 "type": "A String", # The type of the flag. Flags are typed to being BOOLEAN, STRING, INTEGER or NONE. NONE is used for flags which do not take a value, such as skip_grant_tables.
107 },
108 ],
109 "kind": "sql#flagsList", # This is always sql#flagsList.
110 }</pre>
111</div>
112
113</body></html>