Class AggregateQueryStatsRequest.Builder (0.14.0)

public static final class AggregateQueryStatsRequest.Builder extends GeneratedMessage.Builder<AggregateQueryStatsRequest.Builder> implements AggregateQueryStatsRequestOrBuilder

AggregateQueryStatsRequest represents the input to the AggregateQueryStats method.

Protobuf type google.cloud.databasecenter.v1beta.AggregateQueryStatsRequest

Static Methods

getDescriptor()

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

Methods

build()

public AggregateQueryStatsRequest build()
Returns
Type Description
AggregateQueryStatsRequest

buildPartial()

public AggregateQueryStatsRequest buildPartial()
Returns
Type Description
AggregateQueryStatsRequest

clear()

public AggregateQueryStatsRequest.Builder clear()
Returns
Type Description
AggregateQueryStatsRequest.Builder
Overrides

clearFilter()

public AggregateQueryStatsRequest.Builder clearFilter()

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" Additional specific fields for query stats are: metric_window, query_hash, normalized_query. Example: metric_window="LAST_ONE_DAY" (Possible values for metric_window are: LAST_ONE_DAY, LAST_ONE_WEEK, LAST_TWO_WEEKS) Example: query_hash="12345678" Example: normalized_query="SELECT * FROM table"

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

Returns
Type Description
AggregateQueryStatsRequest.Builder

This builder for chaining.

clearOrderBy()

public AggregateQueryStatsRequest.Builder clearOrderBy()

Optional. The expression to order the results by. Example: order_by="execution_count" Example: order_by="execution_count desc" Supported order by fields are execution_count, rows_processed, total_cpu_time, avg_cpu_time.

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

Returns
Type Description
AggregateQueryStatsRequest.Builder

This builder for chaining.

clearPageSize()

public AggregateQueryStatsRequest.Builder clearPageSize()

Optional. If unspecified, at most 100 query stats will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Returns
Type Description
AggregateQueryStatsRequest.Builder

This builder for chaining.

clearPageToken()

public AggregateQueryStatsRequest.Builder clearPageToken()

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

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

Returns
Type Description
AggregateQueryStatsRequest.Builder

This builder for chaining.

clearParent()

public AggregateQueryStatsRequest.Builder clearParent()

Required. Parent can be a project, a folder, or an organization. The search is limited to the resources within the parent.

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
AggregateQueryStatsRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public AggregateQueryStatsRequest getDefaultInstanceForType()
Returns
Type Description
AggregateQueryStatsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

public String getFilter()

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" Additional specific fields for query stats are: metric_window, query_hash, normalized_query. Example: metric_window="LAST_ONE_DAY" (Possible values for metric_window are: LAST_ONE_DAY, LAST_ONE_WEEK, LAST_TWO_WEEKS) Example: query_hash="12345678" Example: normalized_query="SELECT * FROM table"

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

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" Additional specific fields for query stats are: metric_window, query_hash, normalized_query. Example: metric_window="LAST_ONE_DAY" (Possible values for metric_window are: LAST_ONE_DAY, LAST_ONE_WEEK, LAST_TWO_WEEKS) Example: query_hash="12345678" Example: normalized_query="SELECT * FROM table"

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

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. The expression to order the results by. Example: order_by="execution_count" Example: order_by="execution_count desc" Supported order by fields are execution_count, rows_processed, total_cpu_time, avg_cpu_time.

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

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. The expression to order the results by. Example: order_by="execution_count" Example: order_by="execution_count desc" Supported order by fields are execution_count, rows_processed, total_cpu_time, avg_cpu_time.

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

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. If unspecified, at most 100 query stats will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

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

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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

string page_token = 5 [(.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 parent.

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AggregateQueryStatsRequest other)

public AggregateQueryStatsRequest.Builder mergeFrom(AggregateQueryStatsRequest other)
Parameter
Name Description
other AggregateQueryStatsRequest
Returns
Type Description
AggregateQueryStatsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AggregateQueryStatsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregateQueryStatsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AggregateQueryStatsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AggregateQueryStatsRequest.Builder
Overrides

setFilter(String value)

public AggregateQueryStatsRequest.Builder setFilter(String value)

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" Additional specific fields for query stats are: metric_window, query_hash, normalized_query. Example: metric_window="LAST_ONE_DAY" (Possible values for metric_window are: LAST_ONE_DAY, LAST_ONE_WEEK, LAST_TWO_WEEKS) Example: query_hash="12345678" Example: normalized_query="SELECT * FROM table"

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
AggregateQueryStatsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public AggregateQueryStatsRequest.Builder setFilterBytes(ByteString value)

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" Additional specific fields for query stats are: metric_window, query_hash, normalized_query. Example: metric_window="LAST_ONE_DAY" (Possible values for metric_window are: LAST_ONE_DAY, LAST_ONE_WEEK, LAST_TWO_WEEKS) Example: query_hash="12345678" Example: normalized_query="SELECT * FROM table"

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
AggregateQueryStatsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public AggregateQueryStatsRequest.Builder setOrderBy(String value)

Optional. The expression to order the results by. Example: order_by="execution_count" Example: order_by="execution_count desc" Supported order by fields are execution_count, rows_processed, total_cpu_time, avg_cpu_time.

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

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
AggregateQueryStatsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public AggregateQueryStatsRequest.Builder setOrderByBytes(ByteString value)

Optional. The expression to order the results by. Example: order_by="execution_count" Example: order_by="execution_count desc" Supported order by fields are execution_count, rows_processed, total_cpu_time, avg_cpu_time.

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

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
AggregateQueryStatsRequest.Builder

This builder for chaining.

setPageSize(int value)

public AggregateQueryStatsRequest.Builder setPageSize(int value)

Optional. If unspecified, at most 100 query stats will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
AggregateQueryStatsRequest.Builder

This builder for chaining.

setPageToken(String value)

public AggregateQueryStatsRequest.Builder setPageToken(String value)

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

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
AggregateQueryStatsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public AggregateQueryStatsRequest.Builder setPageTokenBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
AggregateQueryStatsRequest.Builder

This builder for chaining.

setParent(String value)

public AggregateQueryStatsRequest.Builder setParent(String value)

Required. Parent can be a project, a folder, or an organization. The search is limited to the resources within the parent.

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];

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
AggregateQueryStatsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public AggregateQueryStatsRequest.Builder setParentBytes(ByteString value)

Required. Parent can be a project, a folder, or an organization. The search is limited to the resources within the parent.

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];

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
AggregateQueryStatsRequest.Builder

This builder for chaining.