blob: 61b3099580f8dba93bd2c27e358ae98047ab36c2 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070081 <code><a href="#list">list(databaseVersion=None, x__xgafv=None)</a></code></p>
yoshi-code-bota36e3b12021-07-27 00:20:26 -070082<p class="firstline">Lists all available database flags for Cloud SQL instances.</p>
Craig Citroe633be12015-03-02 13:40:36 -080083<h3>Method Details</h3>
84<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -070090 <code class="details" id="list">list(databaseVersion=None, x__xgafv=None)</code>
yoshi-code-bota36e3b12021-07-27 00:20:26 -070091 <pre>Lists all available database flags for Cloud SQL instances.
Craig Citroe633be12015-03-02 13:40:36 -080092
93Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070094 databaseVersion: string, Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions.
Dan O'Mearadd494642020-05-01 07:42:23 -070095 x__xgafv: string, V1 error format.
96 Allowed values
97 1 - v1 error format
98 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -080099
100Returns:
101 An object of the form:
102
103 { # Flags list response.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800104 &quot;items&quot;: [ # List of flags.
105 { # A flag resource.
106 &quot;allowedIntValues&quot;: [ # Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values.
107 &quot;A String&quot;,
108 ],
109 &quot;allowedStringValues&quot;: [ # For *STRING* flags, a list of strings that the value can be set to.
110 &quot;A String&quot;,
111 ],
112 &quot;appliesTo&quot;: [ # The database version this flag applies to. Can be *MYSQL_8_0*, *MYSQL_5_6*, or *MYSQL_5_7*.
113 &quot;A String&quot;,
114 ],
115 &quot;inBeta&quot;: True or False, # Whether or not the flag is considered in beta.
116 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#flag*.
117 &quot;maxValue&quot;: &quot;A String&quot;, # For *INTEGER* flags, the maximum allowed value.
118 &quot;minValue&quot;: &quot;A String&quot;, # For *INTEGER* flags, the minimum allowed value.
119 &quot;name&quot;: &quot;A String&quot;, # This is the name of the flag. Flag names always use underscores, not hyphens, for example: *max_allowed_packet*
yoshi-code-bota36e3b12021-07-27 00:20:26 -0700120 &quot;requiresRestart&quot;: True or False, # Indicates whether changing this flag will trigger a database restart.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800121 &quot;type&quot;: &quot;A String&quot;, # 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*.
122 },
123 ],
124 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#flagsList*.
125}</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800126</div>
127
128</body></html>