Class QueryDatabaseResourceGroupsRequest (0.6.0)

public final class QueryDatabaseResourceGroupsRequest extends GeneratedMessage implements QueryDatabaseResourceGroupsRequestOrBuilder

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

Protobuf type google.cloud.databasecenter.v1beta.QueryDatabaseResourceGroupsRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > QueryDatabaseResourceGroupsRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

SIGNAL_FILTERS_FIELD_NUMBER

public static final int SIGNAL_FILTERS_FIELD_NUMBER
Field Value
Type Description
int

SIGNAL_TYPE_GROUPS_FIELD_NUMBER

public static final int SIGNAL_TYPE_GROUPS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static QueryDatabaseResourceGroupsRequest getDefaultInstance()
Returns
Type Description
QueryDatabaseResourceGroupsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static QueryDatabaseResourceGroupsRequest.Builder newBuilder()
Returns
Type Description
QueryDatabaseResourceGroupsRequest.Builder

newBuilder(QueryDatabaseResourceGroupsRequest prototype)

public static QueryDatabaseResourceGroupsRequest.Builder newBuilder(QueryDatabaseResourceGroupsRequest prototype)
Parameter
Name Description
prototype QueryDatabaseResourceGroupsRequest
Returns
Type Description
QueryDatabaseResourceGroupsRequest.Builder

parseDelimitedFrom(InputStream input)

public static QueryDatabaseResourceGroupsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
QueryDatabaseResourceGroupsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryDatabaseResourceGroupsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryDatabaseResourceGroupsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static QueryDatabaseResourceGroupsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
QueryDatabaseResourceGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static QueryDatabaseResourceGroupsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryDatabaseResourceGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static QueryDatabaseResourceGroupsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
QueryDatabaseResourceGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static QueryDatabaseResourceGroupsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryDatabaseResourceGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static QueryDatabaseResourceGroupsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
QueryDatabaseResourceGroupsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryDatabaseResourceGroupsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryDatabaseResourceGroupsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static QueryDatabaseResourceGroupsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
QueryDatabaseResourceGroupsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryDatabaseResourceGroupsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryDatabaseResourceGroupsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static QueryDatabaseResourceGroupsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
QueryDatabaseResourceGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static QueryDatabaseResourceGroupsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryDatabaseResourceGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<QueryDatabaseResourceGroupsRequest> parser()
Returns
Type Description
Parser<QueryDatabaseResourceGroupsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public QueryDatabaseResourceGroupsRequest getDefaultInstanceForType()
Returns
Type Description
QueryDatabaseResourceGroupsRequest

getFilter()

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

getParserForType()

public Parser<QueryDatabaseResourceGroupsRequest> getParserForType()
Returns
Type Description
Parser<QueryDatabaseResourceGroupsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSignalFilters(int index)

public 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 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 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 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 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 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 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 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 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 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>

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public QueryDatabaseResourceGroupsRequest.Builder newBuilderForType()
Returns
Type Description
QueryDatabaseResourceGroupsRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected QueryDatabaseResourceGroupsRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
QueryDatabaseResourceGroupsRequest.Builder
Overrides

toBuilder()

public QueryDatabaseResourceGroupsRequest.Builder toBuilder()
Returns
Type Description
QueryDatabaseResourceGroupsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException