Cloud Spanner V1 Client - Class ListInstancesRequest (1.54.2)

Version 1.54.2

• 1.91.0 (latest)
• 1.90.0
• 1.89.0
• 1.88.0
• 1.87.0
• 1.86.0
• 1.85.0
• 1.84.0
• 1.83.0
• 1.82.0
• 1.81.0
• 1.80.0
• 1.79.0
• 1.78.0
• 1.77.0
• 1.76.1
• 1.68.0
• 1.67.0
• 1.66.0
• 1.65.0
• 1.64.0
• 1.63.2
• 1.62.1
• 1.61.0
• 1.60.0
• 1.59.0
• 1.58.4
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.2

Reference documentation and code samples for the Cloud Spanner V1 Client class ListInstancesRequest.

The request for ListInstances.

Generated from protobuf message google.spanner.admin.instance.v1.ListInstancesRequest

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The name of the project for which a list of instances is requested. Values are of the form projects/<project>.
↳ page_size	int Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
↳ page_token	string If non-empty, page_token should contain a next_page_token from a previous ListInstancesResponse.
↳ filter	string An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * name * display_name * labels.key where key is the name of a label Some examples of using filters are: * name:* --> The instance has a name. * name:Howl --> The instance's name contains the string "howl". * name:HOWL --> Equivalent to above. * NAME:howl --> Equivalent to above. * labels.env:* --> The instance has the label "env". * labels.env:dev --> The instance has the label "env" and the value of the label contains the string "dev". * name:howl labels.env:dev --> The instance's name contains "howl" and it has the label "env" with its value containing "dev".

getParent

Required. The name of the project for which a list of instances is requested. Values are of the form projects/<project>.

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
Type	Description
string

setParent

Required. The name of the project for which a list of instances is requested. Values are of the form projects/<project>.

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

Generated from protobuf field int32 page_size = 2;

Returns
Type	Description
int

setPageSize

Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

Generated from protobuf field int32 page_size = 2;

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

If non-empty, page_token should contain a next_page_token from a previous ListInstancesResponse.

Generated from protobuf field string page_token = 3;

Returns
Type	Description
string

setPageToken

If non-empty, page_token should contain a next_page_token from a previous ListInstancesResponse.

Generated from protobuf field string page_token = 3;

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFilter

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

• name
• display_name
• labels.key where key is the name of a label Some examples of using filters are:
• name:* --> The instance has a name.

• name:Howl --> The instance's name contains the string "howl".
  • name:HOWL --> Equivalent to above.
  • NAME:howl --> Equivalent to above.
  • labels.env:* --> The instance has the label "env".
  • labels.env:dev --> The instance has the label "env" and the value of the label contains the string "dev".
  • name:howl labels.env:dev --> The instance's name contains "howl" and it has the label "env" with its value containing "dev".

Generated from protobuf field string filter = 4;

Returns
Type	Description
string

setFilter

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

• name
• display_name
• labels.key where key is the name of a label Some examples of using filters are:
• name:* --> The instance has a name.

• name:Howl --> The instance's name contains the string "howl".
  • name:HOWL --> Equivalent to above.
  • NAME:howl --> Equivalent to above.
  • labels.env:* --> The instance has the label "env".
  • labels.env:dev --> The instance has the label "env" and the value of the label contains the string "dev".
  • name:howl labels.env:dev --> The instance's name contains "howl" and it has the label "env" with its value containing "dev".

Generated from protobuf field string filter = 4;

Parameter
Name	Description
var	string

Returns
Type	Description
$this