Cloud Spanner V1 Client - Class ListInstancesRequest (1.84.0)

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

Namespace

Google \ Cloud \ Spanner \ Admin \ Instance \ V1

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".
↳ instance_deadline Google\Protobuf\Timestamp

Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.

getParent

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

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>.

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.

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.

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.

Returns
Type Description
string

setPageToken

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

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".
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".
Parameter
Name Description
var string
Returns
Type Description
$this

getInstanceDeadline

Deadline used while retrieving metadata for instances.

Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasInstanceDeadline

clearInstanceDeadline

setInstanceDeadline

Deadline used while retrieving metadata for instances.

Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The name of the project for which a list of instances is requested. Values are of the form projects/<project>. Please see Google\Cloud\Spanner\Admin\Instance\V1\InstanceAdminClient::projectName() for help formatting this field.
Returns
Type Description
Google\Cloud\Spanner\Admin\Instance\V1\ListInstancesRequest