Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class SqlInstancesListRequest.
Instance list request.
Generated from protobuf messagegoogle.cloud.sql.v1.SqlInstancesListRequest
Namespace
Google \ Cloud \ Sql \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ filter
string
A filter expression that filters resources listed in the response. The expression is in the form of field:value. For example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON representation, such as 'settings.userLabels.auto_start:true'. Multiple filter queries are space-separated. For example. 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.
↳ max_results
int
The maximum number of instances to return. The service may return fewer than this value. If unspecified, at most 500 instances are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
↳ page_token
string
A previously-returned page token representing part of the larger set of results to view.
↳ project
string
Project ID of the project for which to list Cloud SQL instances.
getFilter
A filter expression that filters resources listed in the response.
The expression is in the form of field:value. For example,
'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per
their JSON representation, such as 'settings.userLabels.auto_start:true'.
Multiple filter queries are space-separated. For example.
'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each
expression is an AND expression. However, you can include AND and OR
expressions explicitly.
Returns
Type
Description
string
setFilter
A filter expression that filters resources listed in the response.
The expression is in the form of field:value. For example,
'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per
their JSON representation, such as 'settings.userLabels.auto_start:true'.
Multiple filter queries are space-separated. For example.
'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each
expression is an AND expression. However, you can include AND and OR
expressions explicitly.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getMaxResults
The maximum number of instances to return. The service may return fewer
than this value.
If unspecified, at most 500 instances are returned.
The maximum value is 1000; values above 1000 are coerced to 1000.
Returns
Type
Description
int
setMaxResults
The maximum number of instances to return. The service may return fewer
than this value.
If unspecified, at most 500 instances are returned.
The maximum value is 1000; values above 1000 are coerced to 1000.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
A previously-returned page token representing part of the larger set of
results to view.
Returns
Type
Description
string
setPageToken
A previously-returned page token representing part of the larger set of
results to view.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getProject
Project ID of the project for which to list Cloud SQL instances.
Returns
Type
Description
string
setProject
Project ID of the project for which to list Cloud SQL instances.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Sql Admin V1 Client - Class SqlInstancesListRequest (1.2.6)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.6 (latest)](/php/docs/reference/cloud-sql-admin/latest/V1.SqlInstancesListRequest)\n- [1.2.5](/php/docs/reference/cloud-sql-admin/1.2.5/V1.SqlInstancesListRequest)\n- [1.1.0](/php/docs/reference/cloud-sql-admin/1.1.0/V1.SqlInstancesListRequest)\n- [1.0.0](/php/docs/reference/cloud-sql-admin/1.0.0/V1.SqlInstancesListRequest)\n- [0.19.0](/php/docs/reference/cloud-sql-admin/0.19.0/V1.SqlInstancesListRequest)\n- [0.18.0](/php/docs/reference/cloud-sql-admin/0.18.0/V1.SqlInstancesListRequest)\n- [0.17.1](/php/docs/reference/cloud-sql-admin/0.17.1/V1.SqlInstancesListRequest)\n- [0.16.1](/php/docs/reference/cloud-sql-admin/0.16.1/V1.SqlInstancesListRequest)\n- [0.12.0](/php/docs/reference/cloud-sql-admin/0.12.0/V1.SqlInstancesListRequest)\n- [0.11.0](/php/docs/reference/cloud-sql-admin/0.11.0/V1.SqlInstancesListRequest)\n- [0.10.0](/php/docs/reference/cloud-sql-admin/0.10.0/V1.SqlInstancesListRequest)\n- [0.9.0](/php/docs/reference/cloud-sql-admin/0.9.0/V1.SqlInstancesListRequest)\n- [0.8.0](/php/docs/reference/cloud-sql-admin/0.8.0/V1.SqlInstancesListRequest)\n- [0.7.0](/php/docs/reference/cloud-sql-admin/0.7.0/V1.SqlInstancesListRequest)\n- [0.6.0](/php/docs/reference/cloud-sql-admin/0.6.0/V1.SqlInstancesListRequest)\n- [0.5.0](/php/docs/reference/cloud-sql-admin/0.5.0/V1.SqlInstancesListRequest)\n- [0.4.1](/php/docs/reference/cloud-sql-admin/0.4.1/V1.SqlInstancesListRequest)\n- [0.3.1](/php/docs/reference/cloud-sql-admin/0.3.1/V1.SqlInstancesListRequest)\n- [0.2.12](/php/docs/reference/cloud-sql-admin/0.2.12/V1.SqlInstancesListRequest) \nReference documentation and code samples for the Google Cloud Sql Admin V1 Client class SqlInstancesListRequest.\n\nInstance list request.\n\nGenerated from protobuf message `google.cloud.sql.v1.SqlInstancesListRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Sql \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getFilter\n\nA filter expression that filters resources listed in the response.\n\nThe expression is in the form of field:value. For example,\n'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per\ntheir JSON representation, such as 'settings.userLabels.auto_start:true'.\nMultiple filter queries are space-separated. For example.\n'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each\nexpression is an AND expression. However, you can include AND and OR\nexpressions explicitly.\n\n### setFilter\n\nA filter expression that filters resources listed in the response.\n\nThe expression is in the form of field:value. For example,\n'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per\ntheir JSON representation, such as 'settings.userLabels.auto_start:true'.\nMultiple filter queries are space-separated. For example.\n'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each\nexpression is an AND expression. However, you can include AND and OR\nexpressions explicitly.\n\n### getMaxResults\n\nThe maximum number of instances to return. The service may return fewer\nthan this value.\n\nIf unspecified, at most 500 instances are returned.\nThe maximum value is 1000; values above 1000 are coerced to 1000.\n\n### setMaxResults\n\nThe maximum number of instances to return. The service may return fewer\nthan this value.\n\nIf unspecified, at most 500 instances are returned.\nThe maximum value is 1000; values above 1000 are coerced to 1000.\n\n### getPageToken\n\nA previously-returned page token representing part of the larger set of\nresults to view.\n\n### setPageToken\n\nA previously-returned page token representing part of the larger set of\nresults to view.\n\n### getProject\n\nProject ID of the project for which to list Cloud SQL instances.\n\n### setProject\n\nProject ID of the project for which to list Cloud SQL instances."]]
