Google Cloud Database Center V1beta Client - Class QueryDatabaseResourceGroupsRequest (0.3.1)

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

QueryDatabaseResourceGroupsRequest is the request to get a list of database groups.

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

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. The following fields are filterable: * * full_resource_name * * resource_type * * container * * product.type * * product.engine * * product.version * * location * * labels * * resource_category * * machine_config.cpu_count * * machine_config.memory_size_bytes * * machine_config.shard_count * * resource_name * * tags * * backupdr_config.backupdr_managed * * edition 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" Example: full_resource_name=~"test" Example: full_resource_name=~"test.*master"
↳ signal_type_groups array<SignalTypeGroup>

Optional. Groups of signal types that are requested.
↳ signal_filters array<SignalFilter>

Optional. Filters based on signals. The list will be ORed together and then ANDed with the filters field above.
↳ order_by string

Optional. A field that specifies the sort order of the results. The following fields are sortable: * * full_resource_name * * product.type * * product.engine * * product.version * * container * * issue_count * * machine_config.vcpu_count * * machine_config.memory_size_bytes * * machine_config.shard_count * * resource_name * * issue_severity * * signal_type * * location * * resource_type * * instance_type * * edition * * metrics.p99_cpu_utilization * * metrics.p95_cpu_utilization * * metrics.current_storage_used_bytes * * metrics.node_count * * metrics.processing_unit_count * * metrics.current_memory_used_bytes * * metrics.peak_storage_utilization * * metrics.peak_number_connections * * metrics.peak_memory_utilization 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 only supports a single field at a time. For example: order_by = "full_resource_name" sorts response in ascending order order_by = "full_resource_name DESC" sorts response in descending order order_by = "issue_count DESC" sorts response in descending order of count of all issues associated with a resource. More explicitly, order_by = "full_resource_name, product" is not supported.
↳ page_size int

Optional. If unspecified, at most 50 resource groups 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 QueryDatabaseResourceGroupsRequest call. Provide this to retrieve the subsequent page. All parameters except page_token should match the parameters in the call that provided the page page token.

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.

The following fields are filterable:

  • full_resource_name
  • resource_type
  • container
  • product.type
  • product.engine
  • product.version
  • location
  • labels
  • resource_category
  • machine_config.cpu_count
  • machine_config.memory_size_bytes
  • machine_config.shard_count
  • resource_name
  • tags
  • backupdr_config.backupdr_managed
  • edition 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" Example: full_resource_name=~"test" Example: full_resource_name=~"test.*master"
Returns
Type Description
string

setFilter

Optional. The expression to filter resources.

The following fields are filterable:

  • full_resource_name
  • resource_type
  • container
  • product.type
  • product.engine
  • product.version
  • location
  • labels
  • resource_category
  • machine_config.cpu_count
  • machine_config.memory_size_bytes
  • machine_config.shard_count
  • resource_name
  • tags
  • backupdr_config.backupdr_managed
  • edition 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" Example: full_resource_name=~"test" Example: full_resource_name=~"test.*master"
Parameter
Name Description
var string
Returns
Type Description
$this

getSignalTypeGroups

Optional. Groups of signal types that are requested.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSignalTypeGroups

Optional. Groups of signal types that are requested.

Parameter
Name Description
var array<SignalTypeGroup>
Returns
Type Description
$this

getSignalFilters

Optional. Filters based on signals. The list will be ORed together and then ANDed with the filters field above.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSignalFilters

Optional. Filters based on signals. The list will be ORed together and then ANDed with the filters field above.

Parameter
Name Description
var array<SignalFilter>
Returns
Type Description
$this

getOrderBy

Optional. A field that specifies the sort order of the results.

The following fields are sortable:

  • full_resource_name
  • product.type
  • product.engine
  • product.version
  • container
  • issue_count
  • machine_config.vcpu_count
  • machine_config.memory_size_bytes
  • machine_config.shard_count
  • resource_name
  • issue_severity
  • signal_type
  • location
  • resource_type
  • instance_type
  • edition
  • metrics.p99_cpu_utilization
  • metrics.p95_cpu_utilization
  • metrics.current_storage_used_bytes
  • metrics.node_count
  • metrics.processing_unit_count
  • metrics.current_memory_used_bytes
  • metrics.peak_storage_utilization
  • metrics.peak_number_connections
  • metrics.peak_memory_utilization 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 only supports a single field at a time. For example: order_by = "full_resource_name" sorts response in ascending order order_by = "full_resource_name DESC" sorts response in descending order order_by = "issue_count DESC" sorts response in descending order of count of all issues associated with a resource. More explicitly, order_by = "full_resource_name, product" is not supported.
Returns
Type Description
string

setOrderBy

Optional. A field that specifies the sort order of the results.

The following fields are sortable:

  • full_resource_name
  • product.type
  • product.engine
  • product.version
  • container
  • issue_count
  • machine_config.vcpu_count
  • machine_config.memory_size_bytes
  • machine_config.shard_count
  • resource_name
  • issue_severity
  • signal_type
  • location
  • resource_type
  • instance_type
  • edition
  • metrics.p99_cpu_utilization
  • metrics.p95_cpu_utilization
  • metrics.current_storage_used_bytes
  • metrics.node_count
  • metrics.processing_unit_count
  • metrics.current_memory_used_bytes
  • metrics.peak_storage_utilization
  • metrics.peak_number_connections
  • metrics.peak_memory_utilization 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 only supports a single field at a time. For example: order_by = "full_resource_name" sorts response in ascending order order_by = "full_resource_name DESC" sorts response in descending order order_by = "issue_count DESC" sorts response in descending order of count of all issues associated with a resource. More explicitly, order_by = "full_resource_name, product" is not supported.
Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. If unspecified, at most 50 resource groups 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 resource groups 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 QueryDatabaseResourceGroupsRequest call. Provide this to retrieve the subsequent page. All parameters except page_token should match the parameters in the call that provided the page page token.

Returns
Type Description
string

setPageToken

Optional. A page token, received from a previous QueryDatabaseResourceGroupsRequest call. Provide this to retrieve the subsequent page. All parameters except page_token should match the parameters in the call that provided the page page token.

Parameter
Name Description
var string
Returns
Type Description
$this