public final class ListGroupStatsRequest extends GeneratedMessageV3 implements ListGroupStatsRequestOrBuilder
Specifies a set of ErrorGroupStats to return.
Protobuf type google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int ALIGNMENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ALIGNMENT_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int GROUP_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ORDER_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 |
|
public static final int PROJECT_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SERVICE_FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TIMED_COUNT_DURATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TIME_RANGE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static ListGroupStatsRequest getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ListGroupStatsRequest.Builder newBuilder()
public static ListGroupStatsRequest.Builder newBuilder(ListGroupStatsRequest prototype)
public static ListGroupStatsRequest parseDelimitedFrom(InputStream input)
public static ListGroupStatsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListGroupStatsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static ListGroupStatsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListGroupStatsRequest parseFrom(ByteString data)
public static ListGroupStatsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListGroupStatsRequest parseFrom(CodedInputStream input)
public static ListGroupStatsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListGroupStatsRequest parseFrom(InputStream input)
public static ListGroupStatsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListGroupStatsRequest parseFrom(ByteBuffer data)
public static ListGroupStatsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ListGroupStatsRequest> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public 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];
public 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.
|
public 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];
public 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.
|
public ListGroupStatsRequest getDefaultInstanceForType()
public 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.
|
public 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.
|
public 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.
|
public ProtocolStringList 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];
public 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];
public 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()
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 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 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.
|
public Parser<ListGroupStatsRequest> getParserForType()
Overrides
public 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.
|
public 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.
|
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public 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];
public 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];
public 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];
public 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];
public 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.
|
public 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];
public 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.
|
public 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.
|
public 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.
|
public 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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ListGroupStatsRequest.Builder newBuilderForType()
protected ListGroupStatsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public ListGroupStatsRequest.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
