ListInstancesRequest
class ListInstancesRequest extends Message
The request for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
Protobuf type Google\Spanner\Admin\Instance\V1\ListInstancesRequest
Methods
No description
Required. The name of the project for which a list of instances is
requested. Values are of the form projects/<project>.
Required. The name of the project for which a list of instances is
requested. Values are of the form projects/<project>.
Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
If non-empty, page_token should contain a
[next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a
previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
If non-empty, page_token should contain a
[next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a
previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
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.
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.
Details
at line 62
__construct()
at line 74
string
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;
at line 86
setParent(string $var)
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;
at line 99
int
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;
at line 111
setPageSize(int $var)
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;
at line 125
string
getPageToken()
If non-empty, page_token should contain a
[next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a
previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
Generated from protobuf field string page_token = 3;
at line 138
setPageToken(string $var)
If non-empty, page_token should contain a
[next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a
previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
Generated from protobuf field string page_token = 3;
at line 165
string
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;
at line 191
setFilter(string $var)
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;