Interface ListGroupStatsRequestOrBuilder (0.175.0-beta)

Version 0.175.0-beta

• 0.176.0-beta (latest)
• 0.175.0-beta
• 0.174.0-beta
• 0.173.0-beta
• 0.172.0-beta
• 0.170.0-beta
• 0.169.0-beta
• 0.168.0-beta
• 0.167.0-beta
• 0.166.0-beta
• 0.165.0-beta
• 0.164.0-beta
• 0.163.0-beta
• 0.162.0-beta
• 0.161.0-beta
• 0.160.0-beta
• 0.158.0-beta
• 0.157.0-beta
• 0.156.0-beta
• 0.155.0-beta
• 0.154.0-beta
• 0.153.0-beta
• 0.152.0-beta
• 0.151.0-beta
• 0.150.0-beta
• 0.149.0-beta
• 0.148.0-beta
• 0.145.0-beta
• 0.144.0-beta
• 0.143.0-beta
• 0.142.0-beta
• 0.141.0-beta
• 0.140.0-beta
• 0.139.0-beta
• 0.138.0-beta
• 0.137.0-beta
• 0.136.0-beta
• 0.135.0-beta
• 0.134.0-beta
• 0.133.0-beta
• 0.132.0-beta
• 0.130.0-beta
• 0.129.0-beta
• 0.128.0-beta
• 0.127.0-beta
• 0.126.0-beta
• 0.125.0-beta
• 0.124.15-beta
• 0.123.4-beta
• 0.122.23-beta

public interface ListGroupStatsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAlignment()

public abstract TimedCountAlignment getAlignment()

Optional. The alignment of the timed counts to be returned. Default is ALIGNMENT_EQUAL_AT_END.

.google.devtools.clouderrorreporting.v1beta1.TimedCountAlignment alignment = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TimedCountAlignment	The alignment.

getAlignmentTime()

public abstract Timestamp getAlignmentTime()

Optional. Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC.

.google.protobuf.Timestamp alignment_time = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Timestamp	The alignmentTime.

getAlignmentTimeOrBuilder()

public abstract TimestampOrBuilder getAlignmentTimeOrBuilder()

Optional. Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC.

.google.protobuf.Timestamp alignment_time = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TimestampOrBuilder

getAlignmentValue()

public abstract int getAlignmentValue()

Optional. The alignment of the timed counts to be returned. Default is ALIGNMENT_EQUAL_AT_END.

.google.devtools.clouderrorreporting.v1beta1.TimedCountAlignment alignment = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for alignment.

getGroupId(int index)

public abstract String getGroupId(int index)

Optional. List all [ErrorGroupStats] [google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats] with these IDs. The group_id is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see Google Cloud Privacy Notice.

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

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The groupId at the given index.

getGroupIdBytes(int index)

public abstract ByteString getGroupIdBytes(int index)

Optional. List all [ErrorGroupStats] [google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats] with these IDs. The group_id is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see Google Cloud Privacy Notice.

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

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the groupId at the given index.

getGroupIdCount()

public abstract int getGroupIdCount()

Optional. List all [ErrorGroupStats] [google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats] with these IDs. The group_id is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see Google Cloud Privacy Notice.

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

Returns
Type	Description
int	The count of groupId.

getGroupIdList()

public abstract List<String> getGroupIdList()

Optional. List all [ErrorGroupStats] [google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats] with these IDs. The group_id is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see Google Cloud Privacy Notice.

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

Returns
Type	Description
List<String>	A list containing the groupId.

getOrder()

public abstract ErrorGroupOrder getOrder()

Optional. The sort order in which the results are returned. Default is COUNT_DESC.

.google.devtools.clouderrorreporting.v1beta1.ErrorGroupOrder order = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ErrorGroupOrder	The order.

getOrderValue()

public abstract int getOrderValue()

Optional. The sort order in which the results are returned. Default is COUNT_DESC.

.google.devtools.clouderrorreporting.v1beta1.ErrorGroupOrder order = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for order.

getPageSize()

public abstract int getPageSize()

Optional. The maximum number of results to return per response. Default is 20.

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

Returns
Type	Description
int	The pageSize.

getPageToken()

public abstract String getPageToken()

Optional. A [next_page_token] [google.devtools.clouderrorreporting.v1beta1.ListGroupStatsResponse.next_page_token] provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request.

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

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

Optional. A [next_page_token] [google.devtools.clouderrorreporting.v1beta1.ListGroupStatsResponse.next_page_token] provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request.

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

Returns
Type	Description
ByteString	The bytes for pageToken.

getProjectName()

public abstract String getProjectName()

Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console. It may also include a location, such as projects/{projectID}/locations/{location} where {location} is a cloud region.

Examples: projects/my-project-123, projects/5551234, projects/my-project-123/locations/us-central1, projects/5551234/locations/us-central1.

For a list of supported locations, see Supported Regions. global is the default when unspecified. Use - as a wildcard to request group stats from all regions.

string project_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The projectName.

getProjectNameBytes()

public abstract ByteString getProjectNameBytes()

Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console. It may also include a location, such as projects/{projectID}/locations/{location} where {location} is a cloud region.

Examples: projects/my-project-123, projects/5551234, projects/my-project-123/locations/us-central1, projects/5551234/locations/us-central1.

For a list of supported locations, see Supported Regions. global is the default when unspecified. Use - as a wildcard to request group stats from all regions.

string project_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for projectName.

getServiceFilter()

public abstract ServiceContextFilter getServiceFilter()

Optional. List only [ErrorGroupStats] [google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats] which belong to a service context that matches the filter. Data for all service contexts is returned if this field is not specified.

.google.devtools.clouderrorreporting.v1beta1.ServiceContextFilter service_filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ServiceContextFilter	The serviceFilter.

getServiceFilterOrBuilder()

public abstract ServiceContextFilterOrBuilder getServiceFilterOrBuilder()

Optional. List only [ErrorGroupStats] [google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats] which belong to a service context that matches the filter. Data for all service contexts is returned if this field is not specified.

.google.devtools.clouderrorreporting.v1beta1.ServiceContextFilter service_filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ServiceContextFilterOrBuilder

getTimeRange()

public abstract QueryTimeRange getTimeRange()

Optional. List data for the given time range. If not set, a default time range is used. The field [time_range_begin] [google.devtools.clouderrorreporting.v1beta1.ListGroupStatsResponse.time_range_begin] in the response will specify the beginning of this time range. Only [ErrorGroupStats] [google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats] with a non-zero count in the given time range are returned, unless the request contains an explicit [group_id] [google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest.group_id] list. If a [group_id] [google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest.group_id] list is given, also [ErrorGroupStats] [google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats] with zero occurrences are returned.

.google.devtools.clouderrorreporting.v1beta1.QueryTimeRange time_range = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
QueryTimeRange	The timeRange.

getTimeRangeOrBuilder()

public abstract QueryTimeRangeOrBuilder getTimeRangeOrBuilder()

Optional. List data for the given time range. If not set, a default time range is used. The field [time_range_begin] [google.devtools.clouderrorreporting.v1beta1.ListGroupStatsResponse.time_range_begin] in the response will specify the beginning of this time range. Only [ErrorGroupStats] [google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats] with a non-zero count in the given time range are returned, unless the request contains an explicit [group_id] [google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest.group_id] list. If a [group_id] [google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest.group_id] list is given, also [ErrorGroupStats] [google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats] with zero occurrences are returned.

.google.devtools.clouderrorreporting.v1beta1.QueryTimeRange time_range = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
QueryTimeRangeOrBuilder

getTimedCountDuration()

public abstract Duration getTimedCountDuration()

Optional. The preferred duration for a single returned [TimedCount] [google.devtools.clouderrorreporting.v1beta1.TimedCount]. If not set, no timed counts are returned.

.google.protobuf.Duration timed_count_duration = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Duration	The timedCountDuration.

getTimedCountDurationOrBuilder()

public abstract DurationOrBuilder getTimedCountDurationOrBuilder()

Optional. The preferred duration for a single returned [TimedCount] [google.devtools.clouderrorreporting.v1beta1.TimedCount]. If not set, no timed counts are returned.

.google.protobuf.Duration timed_count_duration = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DurationOrBuilder

hasAlignmentTime()

public abstract boolean hasAlignmentTime()

Optional. Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC.

.google.protobuf.Timestamp alignment_time = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the alignmentTime field is set.

hasServiceFilter()

public abstract boolean hasServiceFilter()

Optional. List only [ErrorGroupStats] [google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats] which belong to a service context that matches the filter. Data for all service contexts is returned if this field is not specified.

.google.devtools.clouderrorreporting.v1beta1.ServiceContextFilter service_filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the serviceFilter field is set.

hasTimeRange()

public abstract boolean hasTimeRange()

Optional. List data for the given time range. If not set, a default time range is used. The field [time_range_begin] [google.devtools.clouderrorreporting.v1beta1.ListGroupStatsResponse.time_range_begin] in the response will specify the beginning of this time range. Only [ErrorGroupStats] [google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats] with a non-zero count in the given time range are returned, unless the request contains an explicit [group_id] [google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest.group_id] list. If a [group_id] [google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest.group_id] list is given, also [ErrorGroupStats] [google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats] with zero occurrences are returned.

.google.devtools.clouderrorreporting.v1beta1.QueryTimeRange time_range = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the timeRange field is set.

hasTimedCountDuration()

public abstract boolean hasTimedCountDuration()

Optional. The preferred duration for a single returned [TimedCount] [google.devtools.clouderrorreporting.v1beta1.TimedCount]. If not set, no timed counts are returned.

.google.protobuf.Duration timed_count_duration = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the timedCountDuration field is set.