Cloud Spanner V1 Client - Class ListInstanceConfigsRequest (1.60.0)

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

The request for ListInstanceConfigs.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

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

↳ page_size int

Number of instance configurations 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 ListInstanceConfigsResponse.

getParent

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

Returns
TypeDescription
string

setParent

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

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

Returns
TypeDescription
int

setPageSize

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

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

Returns
TypeDescription
string

setPageToken

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parent string

Required. The name of the project for which a list of supported instance configurations is requested. Values are of the form projects/<project>. Please see {@see \Google\Cloud\Spanner\Admin\Instance\V1\InstanceAdminClient::projectName()} for help formatting this field.

Returns
TypeDescription
Google\Cloud\Spanner\Admin\Instance\V1\ListInstanceConfigsRequest