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

Version 0.3.1

• 1.2.1 (latest)
• 1.2.0
• 1.1.0
• 1.0.0
• 0.19.0
• 0.18.0
• 0.17.1
• 0.16.1
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.1
• 0.2.12

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
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 results to return per response.
↳ 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 results to return per response.

Returns
Type	Description
int

setMaxResults

The maximum number of results to return per response.

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this