blob: 9097f594a6b2df08b2df328b8294b6bf0d9d13eb [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="alloydb_v1beta.html">AlloyDB API</a> . <a href="alloydb_v1beta.projects.html">projects</a> . <a href="alloydb_v1beta.projects.locations.html">locations</a> . <a href="alloydb_v1beta.projects.locations.supportedDatabaseFlags.html">supportedDatabaseFlags</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, scope=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists SupportedDatabaseFlags for a given project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, scope=None, x__xgafv=None)</code>
<pre>Lists SupportedDatabaseFlags for a given project and location.
Args:
parent: string, Required. The name of the parent resource. The required format is: * projects/{project}/locations/{location} Regardless of the parent specified here, as long it is contains a valid project and location, the service will return a static list of supported flags resources. Note that we do not yet support region-specific flags. (required)
pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, A token identifying a page of results the server should return.
scope: string, Optional. The scope for which supported flags are requested. If not specified, default is DATABASE.
Allowed values
SCOPE_UNSPECIFIED - The scope of the flag is not specified. Default is DATABASE.
DATABASE - The flag is a database flag.
CONNECTION_POOL - The flag is a connection pool flag.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for response to listing SupportedDatabaseFlags.
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying a page of results the server should return.
&quot;supportedDatabaseFlags&quot;: [ # The list of SupportedDatabaseFlags.
{ # SupportedDatabaseFlag gives general information about a database flag, like type and allowed values. This is a static value that is defined on the server side, and it cannot be modified by callers. To set the Database flags on a particular Instance, a caller should modify the Instance.database_flags field.
&quot;acceptsMultipleValues&quot;: True or False, # Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.
&quot;flagName&quot;: &quot;A String&quot;, # The name of the database flag, e.g. &quot;max_allowed_packets&quot;. The is a possibly key for the Instance.database_flags map field.
&quot;integerRestrictions&quot;: { # Restrictions on INTEGER type values. # Restriction on INTEGER type value.
&quot;maxValue&quot;: &quot;A String&quot;, # The maximum value that can be specified, if applicable.
&quot;minValue&quot;: &quot;A String&quot;, # The minimum value that can be specified, if applicable.
},
&quot;name&quot;: &quot;A String&quot;, # The name of the flag resource, following Google Cloud conventions, e.g.: * projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.
&quot;recommendedIntegerValue&quot;: &quot;A String&quot;, # The recommended value for an INTEGER flag.
&quot;recommendedStringValue&quot;: &quot;A String&quot;, # The recommended value for a STRING flag.
&quot;requiresDbRestart&quot;: True or False, # Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO&#x27;s).
&quot;scope&quot;: &quot;A String&quot;, # The scope of the flag.
&quot;stringRestrictions&quot;: { # Restrictions on STRING type values # Restriction on STRING type value.
&quot;allowedValues&quot;: [ # The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values.
&quot;A String&quot;,
],
},
&quot;supportedDbVersions&quot;: [ # Major database engine versions for which this flag is supported.
&quot;A String&quot;,
],
&quot;valueType&quot;: &quot;A String&quot;,
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>