Google Cloud Sql Admin V1 Client - Class SqlInstancesListRequest (0.8.0)

Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class SqlInstancesListRequest.

Instance list request.

Generated from protobuf message google.cloud.sql.v1.SqlInstancesListRequest

Namespace

Google \ Cloud \ Sql \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

A previously-returned page token representing part of the larger set of results to view.

Returns
TypeDescription
string

setPageToken

A previously-returned page token representing part of the larger set of results to view.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getProject

Project ID of the project for which to list Cloud SQL instances.

Returns
TypeDescription
string

setProject

Project ID of the project for which to list Cloud SQL instances.

Parameter
NameDescription
var string
Returns
TypeDescription
$this