Google Cloud Database Center V1beta Client - Class AggregateFleetRequest (0.5.0)

Reference documentation and code samples for the Google Cloud Database Center V1beta Client class AggregateFleetRequest.

The request message to aggregate fleet which are grouped by a field.

Generated from protobuf message google.cloud.databasecenter.v1beta.AggregateFleetRequest

Namespace

Google \ Cloud \ DatabaseCenter \ V1beta

Methods

__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 scope . 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")

↳ filter
string

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"

↳ group_by
string

Optional. A field that statistics are grouped by. Valid values are any combination of the following: * * container * * product.type * * product.engine * * product.version * * location * * sub_resource_type * * management_type * * tag.key * * tag.value * * tag.source * * tag.inherited * * label.key * * label.value * * label.source * * has_maintenance_schedule * * has_deny_maintenance_schedules Comma separated list.

↳ order_by
string

Optional. Valid values to order by are: * * resource_groups_count * * resources_count * * and all fields supported by group_by The default order is ascending. Add "DESC" after the field name to indicate descending order. Add "ASC" after the field name to indicate ascending order. It supports ordering using multiple fields. For example: order_by = "resource_groups_count" sorts response in ascending order order_by = "resource_groups_count DESC" sorts response in descending order order_by = "product.type, product.version DESC, location" orders by type in ascending order, version in descending order and location in ascending order

↳ page_size
int

Optional. If unspecified, at most 50 items 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 AggregateFleet call. Provide this to retrieve the subsequent page. All other parameters should match the parameters in the call that provided the page token except for page_size which can be different.

↳ baseline_date
Google\Type\Date

Optional. The baseline date w.r.t. which the delta counts are calculated. If not set, delta counts are not included in the response and the response indicates the current state of the fleet.

getParent

Required. Parent can be a project, a folder, or an organization. The search is limited to the resources within the scope .

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 scope .

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

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"

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"

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getGroupBy

Optional. A field that statistics are grouped by.

Valid values are any combination of the following:

  • container
  • product.type
  • product.engine
  • product.version
  • location
  • sub_resource_type
  • management_type
  • tag.key
  • tag.value
  • tag.source
  • tag.inherited
  • label.key
  • label.value
  • label.source
  • has_maintenance_schedule
  • has_deny_maintenance_schedules Comma separated list.
Returns
Type
Description
string

setGroupBy

Optional. A field that statistics are grouped by.

Valid values are any combination of the following:

  • container
  • product.type
  • product.engine
  • product.version
  • location
  • sub_resource_type
  • management_type
  • tag.key
  • tag.value
  • tag.source
  • tag.inherited
  • label.key
  • label.value
  • label.source
  • has_maintenance_schedule
  • has_deny_maintenance_schedules Comma separated list.
Parameter
Name
Description
var
string
Returns
Type
Description
$this

getOrderBy

Optional. Valid values to order by are:

  • resource_groups_count
  • resources_count
  • and all fields supported by group_by The default order is ascending. Add "DESC" after the field name to indicate descending order. Add "ASC" after the field name to indicate ascending order. It supports ordering using multiple fields.

For example: order_by = "resource_groups_count" sorts response in ascending order order_by = "resource_groups_count DESC" sorts response in descending order order_by = "product.type, product.version DESC, location" orders by type in ascending order, version in descending order and location in ascending order

Returns
Type
Description
string

setOrderBy

Optional. Valid values to order by are:

  • resource_groups_count
  • resources_count
  • and all fields supported by group_by The default order is ascending. Add "DESC" after the field name to indicate descending order. Add "ASC" after the field name to indicate ascending order. It supports ordering using multiple fields.

For example: order_by = "resource_groups_count" sorts response in ascending order order_by = "resource_groups_count DESC" sorts response in descending order order_by = "product.type, product.version DESC, location" orders by type in ascending order, version in descending order and location in ascending order

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPageSize

Optional. If unspecified, at most 50 items 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 50 items 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 AggregateFleet call.

Provide this to retrieve the subsequent page. All other parameters should match the parameters in the call that provided the page token except for page_size which can be different.

Returns
Type
Description
string

setPageToken

Optional. A page token, received from a previous AggregateFleet call.

Provide this to retrieve the subsequent page. All other parameters should match the parameters in the call that provided the page token except for page_size which can be different.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getBaselineDate

Optional. The baseline date w.r.t. which the delta counts are calculated.

If not set, delta counts are not included in the response and the response indicates the current state of the fleet.

Returns
Type
Description

hasBaselineDate

clearBaselineDate

setBaselineDate

Optional. The baseline date w.r.t. which the delta counts are calculated.

If not set, delta counts are not included in the response and the response indicates the current state of the fleet.

Parameter
Name
Description
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: