1. class
  2. Google
  3. \
  4. Spanner
  5. \
  6. Admin
  7. \
  8. Database
  9. \
  10. V1
  11. \
  12. ListDatabasesRequest

ListDatabasesRequest

class ListDatabasesRequest extends Message

The request for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].

Protobuf type Google\Spanner\Admin\Database\V1\ListDatabasesRequest

Methods

__construct()

No description

string
getParent()

Required. The instance whose databases should be listed.

setParent(string $var)

Required. The instance whose databases should be listed.

int
getPageSize()

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

setPageSize(int $var)

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

string
getPageToken()

If non-empty, page_token should contain a [next_page_token][google.spanner.admin.database.v1.ListDatabasesResponse.next_page_token] from a previous [ListDatabasesResponse][google.spanner.admin.database.v1.ListDatabasesResponse].

setPageToken(string $var)

If non-empty, page_token should contain a [next_page_token][google.spanner.admin.database.v1.ListDatabasesResponse.next_page_token] from a previous [ListDatabasesResponse][google.spanner.admin.database.v1.ListDatabasesResponse].

Details

at line 41
__construct()

at line 53
string getParent()

Required. The instance whose databases should be listed.

Values are of the form projects/<project>/instances/<instance>.

Generated from protobuf field string parent = 1;

Return Value

string

at line 65
setParent(string $var)

Required. The instance whose databases should be listed.

Values are of the form projects/<project>/instances/<instance>.

Generated from protobuf field string parent = 1;

Parameters

string $var

at line 78
int getPageSize()

Number of databases 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 = 3;

Return Value

int

at line 90
setPageSize(int $var)

Number of databases 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 = 3;

Parameters

int $var

at line 104
string getPageToken()

If non-empty, page_token should contain a [next_page_token][google.spanner.admin.database.v1.ListDatabasesResponse.next_page_token] from a previous [ListDatabasesResponse][google.spanner.admin.database.v1.ListDatabasesResponse].

Generated from protobuf field string page_token = 4;

Return Value

string

at line 117
setPageToken(string $var)

If non-empty, page_token should contain a [next_page_token][google.spanner.admin.database.v1.ListDatabasesResponse.next_page_token] from a previous [ListDatabasesResponse][google.spanner.admin.database.v1.ListDatabasesResponse].

Generated from protobuf field string page_token = 4;

Parameters

string $var