Reference documentation and code samples for the Google Cloud Database Center V1beta Client class AggregateQueryStatsRequest.
AggregateQueryStatsRequest represents the input to the AggregateQueryStats method.
Generated from protobuf message google.cloud.databasecenter.v1beta.AggregateQueryStatsRequest
Namespace
Google \ Cloud \ DatabaseCenter \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. Parent can be a project, a folder, or an organization. The search is limited to the resources within the |
↳ order_by |
string
Optional. The expression to order the results by. Example: |
↳ filter |
string
Optional. The expression to filter resources. Supported fields are: |
↳ page_size |
int
Optional. If unspecified, at most 100 query stats will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
↳ page_token |
string
Optional. A page token, received from a previous |
getParent
Required. Parent can be a project, a folder, or an organization. The search
is limited to the resources within the parent.
The allowed values are:
- projects/{PROJECT_ID} (e.g., "projects/foo-bar")
- projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
- folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
- organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. Parent can be a project, a folder, or an organization. The search
is limited to the resources within the parent.
The allowed values are:
- projects/{PROJECT_ID} (e.g., "projects/foo-bar")
- projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
- folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
- organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrderBy
Optional. The expression to order the results by.
Example: order_by="execution_count"
Example: order_by="execution_count desc"
Supported order by fields are execution_count, rows_processed,
total_cpu_time, avg_cpu_time.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrderBy
Optional. The expression to order the results by.
Example: order_by="execution_count"
Example: order_by="execution_count desc"
Supported order by fields are execution_count, rows_processed,
total_cpu_time, avg_cpu_time.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Optional. The expression to filter resources.
Supported fields are: full_resource_name, resource_type, container,
product.type, product.engine, product.version, location,
labels, issues, fields of availability_info,
data_protection_info,'resource_name', etc.
The expression is a list of zero or more restrictions combined via logical
operators AND and OR. When AND and OR are both used in the
expression, parentheses must be appropriately used to group the
combinations.
Example: location="us-east1"
Example: container="projects/123" OR container="projects/456"
Example: (container="projects/123" OR
container="projects/456") AND location="us-east1"
Additional specific fields for query stats are: metric_window,
query_hash, normalized_query.
Example: metric_window="LAST_ONE_DAY"
(Possible values for metric_window are: LAST_ONE_DAY,
LAST_ONE_WEEK, LAST_TWO_WEEKS)
Example: query_hash="12345678"
Example: normalized_query="SELECT * FROM table"
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Optional. The expression to filter resources.
Supported fields are: full_resource_name, resource_type, container,
product.type, product.engine, product.version, location,
labels, issues, fields of availability_info,
data_protection_info,'resource_name', etc.
The expression is a list of zero or more restrictions combined via logical
operators AND and OR. When AND and OR are both used in the
expression, parentheses must be appropriately used to group the
combinations.
Example: location="us-east1"
Example: container="projects/123" OR container="projects/456"
Example: (container="projects/123" OR
container="projects/456") AND location="us-east1"
Additional specific fields for query stats are: metric_window,
query_hash, normalized_query.
Example: metric_window="LAST_ONE_DAY"
(Possible values for metric_window are: LAST_ONE_DAY,
LAST_ONE_WEEK, LAST_TWO_WEEKS)
Example: query_hash="12345678"
Example: normalized_query="SELECT * FROM table"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. If unspecified, at most 100 query stats will be returned.
The maximum value is 1000; values above 1000 will be coerced to 1000.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. If unspecified, at most 100 query stats will be returned.
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
AggregateQueryStatsRequest call. Provide this to retrieve the subsequent
page. All parameters except page_token should match the parameters in the
call that provided the page token.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. A page token, received from a previous
AggregateQueryStatsRequest call. Provide this to retrieve the subsequent
page. All parameters except page_token should match the parameters in the
call that provided the page token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|