Reference documentation and code samples for the Google Cloud Capacity Planner V1beta Client class QueryCapacityPlansRequest.
Request for querying capacity plans.
Generated from protobuf message google.cloud.capacityplanner.v1beta.QueryCapacityPlansRequest
Namespace
Google \ Cloud \ CapacityPlanner \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent resource container. Format: projects/{project} or folders/{folder} or organizations/{organization} |
↳ page_size |
int
Optional. The maximum number of plans to return per page. The service may return fewer than this value. If unspecified, the server will use a sensible default. The maximum value is 1000; values above 1000 will be coerced to 1000. |
↳ page_token |
string
Optional. A page token, received from a previous |
↳ location |
string
Optional. The Google Cloud Platform location of capacity plans. If unspecified, all locations will be included. |
getParent
Required. The parent resource container.
Format: projects/{project} or folders/{folder} or organizations/{organization}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent resource container.
Format: projects/{project} or folders/{folder} or organizations/{organization}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. The maximum number of plans to return per page. The service may return fewer than this value. If unspecified, the server will use a sensible default. The maximum value is 1000; values above 1000 will be coerced to 1000.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. The maximum number of plans to return per page. The service may return fewer than this value. If unspecified, the server will use a sensible default. The maximum value is 1000; values above 1000 will be coerced to 1000.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. A page token, received from a previous QueryCapacityPlans call.
Provide this to retrieve the subsequent page.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. A page token, received from a previous QueryCapacityPlans call.
Provide this to retrieve the subsequent page.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLocation
Optional. The Google Cloud Platform location of capacity plans. If unspecified, all locations will be included.
| Returns | |
|---|---|
| Type | Description |
string |
|
setLocation
Optional. The Google Cloud Platform location of capacity plans. If unspecified, all locations will be included.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The parent resource container. Format: projects/{project} or folders/{folder} or organizations/{organization} Please see CapacityPlanningServiceClient::projectName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
QueryCapacityPlansRequest |
|