Database Center V1BETA API - Class Google::Cloud::DatabaseCenter::V1beta::AggregateFleetRequest (v0.1.0)

Reference documentation and code samples for the Database Center V1BETA API class Google::Cloud::DatabaseCenter::V1beta::AggregateFleetRequest.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#baseline_date

def baseline_date() -> ::Google::Type::Date
Returns
  • (::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.

#baseline_date=

def baseline_date=(value) -> ::Google::Type::Date
Parameter
  • value (::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.
Returns
  • (::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.

#filter

def filter() -> ::String
Returns
  • (::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"

#filter=

def filter=(value) -> ::String
Parameter
  • value (::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"

Returns
  • (::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

def group_by() -> ::String
Returns
  • (::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.

#group_by=

def group_by=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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

def order_by() -> ::String
Returns
  • (::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

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::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
Returns
  • (::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

def page_size() -> ::Integer
Returns
  • (::Integer) — Optional. If unspecified, at most 50 items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. If unspecified, at most 50 items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Returns
  • (::Integer) — 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

def page_token() -> ::String
Returns
  • (::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.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#parent

def parent() -> ::String
Returns
  • (::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")

#parent=

def parent=(value) -> ::String
Parameter
  • value (::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")
Returns
  • (::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")