Class AggregateQueryStatsRequest (0.14.0) 

public final class AggregateQueryStatsRequest extends GeneratedMessage implements AggregateQueryStatsRequestOrBuilder

AggregateQueryStatsRequest represents the input to the AggregateQueryStats method.

Protobuf type google.cloud.databasecenter.v1beta.AggregateQueryStatsRequest

Inheritance

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

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

Static Methods

getDefaultInstance()

public static AggregateQueryStatsRequest getDefaultInstance()
Returns
Type Description
AggregateQueryStatsRequest

getDescriptor()

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

newBuilder()

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

newBuilder(AggregateQueryStatsRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public AggregateQueryStatsRequest getDefaultInstanceForType()
Returns
Type Description
AggregateQueryStatsRequest

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.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 AggregateQueryStatsRequest.Builder newBuilderForType()
Returns
Type Description
AggregateQueryStatsRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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