Class: Google::Cloud::DatabaseCenter::V1beta::QueryDatabaseResourceGroupsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/databasecenter/v1beta/service.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

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

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



180
181
182
183
 
# File 'proto_docs/google/cloud/databasecenter/v1beta/service.rb', line 180

class QueryDatabaseResourceGroupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_by ⇒ ::String

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

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



180
181
182
183
 
# File 'proto_docs/google/cloud/databasecenter/v1beta/service.rb', line 180

class QueryDatabaseResourceGroupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

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

  • (::Integer) —

    Optional. If unspecified, at most 50 resource groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.



180
181
182
183
 
# File 'proto_docs/google/cloud/databasecenter/v1beta/service.rb', line 180

class QueryDatabaseResourceGroupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

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

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



180
181
182
183
 
# File 'proto_docs/google/cloud/databasecenter/v1beta/service.rb', line 180

class QueryDatabaseResourceGroupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns 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")


180
181
182
183
 
# File 'proto_docs/google/cloud/databasecenter/v1beta/service.rb', line 180

class QueryDatabaseResourceGroupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#signal_filters ⇒ ::Array<::Google::Cloud::DatabaseCenter::V1beta::SignalFilter>

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

Returns:



180
181
182
183
 
# File 'proto_docs/google/cloud/databasecenter/v1beta/service.rb', line 180

class QueryDatabaseResourceGroupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#signal_type_groups ⇒ ::Array<::Google::Cloud::DatabaseCenter::V1beta::SignalTypeGroup>

Returns Optional. Groups of signal types that are requested.

Returns:



180
181
182
183
 
# File 'proto_docs/google/cloud/databasecenter/v1beta/service.rb', line 180

class QueryDatabaseResourceGroupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end