Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / sqladmin_v1beta4.flags.html
blob: 2e01143b617cab38b9354f9602e3259f3df0dd81 [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1<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 -0700[diff] [blame]75<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 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#list">list(x__xgafv=None, databaseVersion=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">List all available database flags for Cloud SQL instances.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]80<h3>Method Details</h3>
81<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]82 <code class="details" id="list">list(x__xgafv=None, databaseVersion=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83 <pre>List all available database flags for Cloud SQL instances.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]84
85Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]86 x__xgafv: string, V1 error format.
87 Allowed values
88 1 - v1 error format
89 2 - v2 error format
90 databaseVersion: string, Database type and version you want to retrieve flags for. By default, this
91method returns flags for all database types and versions.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]92
93Returns:
94 An object of the form:
95
96 { # Flags list response.
97 "items": [ # List of flags.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 { # A flag resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]99 "inBeta": True or False, # Whether or not the flag is considered in beta.
100 "kind": "A String", # This is always &lt;code&gt;sql#flag&lt;/code&gt;.
101 "name": "A String", # This is the name of the flag. Flag names always use underscores, not
102 # hyphens, e.g. &lt;code&gt;max_allowed_packet&lt;/code&gt;
103 "allowedStringValues": [ # For &lt;code&gt;STRING&lt;/code&gt; flags, a list of strings that the value can be set
104 # to.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]105 "A String",
106 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]107 "requiresRestart": True or False, # Indicates whether changing this flag will trigger a database restart. Only
108 # applicable to Second Generation instances.
109 "appliesTo": [ # The database version this flag applies to. Can be &lt;code&gt;MYSQL_5_5&lt;/code&gt;,
110 # &lt;code&gt;MYSQL_5_6&lt;/code&gt;, or &lt;code&gt;MYSQL_5_7&lt;/code&gt;. &lt;code&gt;MYSQL_5_7&lt;/code&gt;
111 # is applicable only to Second Generation instances.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]112 "A String",
113 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]114 "maxValue": "A String", # For &lt;code&gt;INTEGER&lt;/code&gt; flags, the maximum allowed value.
115 "minValue": "A String", # For &lt;code&gt;INTEGER&lt;/code&gt; flags, the minimum allowed value.
116 "type": "A String", # The type of the flag. Flags are typed to being &lt;code&gt;BOOLEAN&lt;/code&gt;,
117 # &lt;code&gt;STRING&lt;/code&gt;, &lt;code&gt;INTEGER&lt;/code&gt; or &lt;code&gt;NONE&lt;/code&gt;.
118 # &lt;code&gt;NONE&lt;/code&gt; is used for flags which do not take a value, such as
119 # &lt;code&gt;skip_grant_tables&lt;/code&gt;.
120 "allowedIntValues": [ # Use this field if only certain integers are accepted. Can be combined
121 # with min_value and max_value to add additional values.
122 "A String",
123 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]124 },
125 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]126 "kind": "A String", # This is always &lt;code&gt;sql#flagsList&lt;/code&gt;.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]127 }</pre>
128</div>
129
130</body></html>