Interface QueryDatabaseResourceGroupsRequestOrBuilder (0.6.0)

public interface QueryDatabaseResourceGroupsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String 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"

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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"

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public abstract String 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.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public abstract ByteString getOrderByBytes()

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.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public abstract int 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.

int32 page_size = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public abstract String 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.

string page_token = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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.

string page_token = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract String 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")

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for parent.

getSignalFilters(int index)

public abstract SignalFilter getSignalFilters(int index)

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

repeated .google.cloud.databasecenter.v1beta.SignalFilter signal_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
SignalFilter

getSignalFiltersCount()

public abstract int getSignalFiltersCount()

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

repeated .google.cloud.databasecenter.v1beta.SignalFilter signal_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getSignalFiltersList()

public abstract List<SignalFilter> getSignalFiltersList()

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

repeated .google.cloud.databasecenter.v1beta.SignalFilter signal_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<SignalFilter>

getSignalFiltersOrBuilder(int index)

public abstract SignalFilterOrBuilder getSignalFiltersOrBuilder(int index)

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

repeated .google.cloud.databasecenter.v1beta.SignalFilter signal_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
SignalFilterOrBuilder

getSignalFiltersOrBuilderList()

public abstract List<? extends SignalFilterOrBuilder> getSignalFiltersOrBuilderList()

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

repeated .google.cloud.databasecenter.v1beta.SignalFilter signal_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.databasecenter.v1beta.SignalFilterOrBuilder>

getSignalTypeGroups(int index)

public abstract SignalTypeGroup getSignalTypeGroups(int index)

Optional. Groups of signal types that are requested.

repeated .google.cloud.databasecenter.v1beta.SignalTypeGroup signal_type_groups = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
SignalTypeGroup

getSignalTypeGroupsCount()

public abstract int getSignalTypeGroupsCount()

Optional. Groups of signal types that are requested.

repeated .google.cloud.databasecenter.v1beta.SignalTypeGroup signal_type_groups = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getSignalTypeGroupsList()

public abstract List<SignalTypeGroup> getSignalTypeGroupsList()

Optional. Groups of signal types that are requested.

repeated .google.cloud.databasecenter.v1beta.SignalTypeGroup signal_type_groups = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<SignalTypeGroup>

getSignalTypeGroupsOrBuilder(int index)

public abstract SignalTypeGroupOrBuilder getSignalTypeGroupsOrBuilder(int index)

Optional. Groups of signal types that are requested.

repeated .google.cloud.databasecenter.v1beta.SignalTypeGroup signal_type_groups = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
SignalTypeGroupOrBuilder

getSignalTypeGroupsOrBuilderList()

public abstract List<? extends SignalTypeGroupOrBuilder> getSignalTypeGroupsOrBuilderList()

Optional. Groups of signal types that are requested.

repeated .google.cloud.databasecenter.v1beta.SignalTypeGroup signal_type_groups = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.databasecenter.v1beta.SignalTypeGroupOrBuilder>