Class ListGroupStatsRequest (0.176.0-beta) 

public final class ListGroupStatsRequest extends GeneratedMessageV3 implements ListGroupStatsRequestOrBuilder

Specifies a set of ErrorGroupStats to return.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ListGroupStatsRequest

Static Fields

ALIGNMENT_FIELD_NUMBER

public static final int ALIGNMENT_FIELD_NUMBER
Field Value
Type Description
int

ALIGNMENT_TIME_FIELD_NUMBER

public static final int ALIGNMENT_TIME_FIELD_NUMBER
Field Value
Type Description
int

GROUP_ID_FIELD_NUMBER

public static final int GROUP_ID_FIELD_NUMBER
Field Value
Type Description
int

ORDER_FIELD_NUMBER

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

PROJECT_NAME_FIELD_NUMBER

public static final int PROJECT_NAME_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_FILTER_FIELD_NUMBER

public static final int SERVICE_FILTER_FIELD_NUMBER
Field Value
Type Description
int

TIMED_COUNT_DURATION_FIELD_NUMBER

public static final int TIMED_COUNT_DURATION_FIELD_NUMBER
Field Value
Type Description
int

TIME_RANGE_FIELD_NUMBER

public static final int TIME_RANGE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListGroupStatsRequest getDefaultInstance()
Returns
Type Description
ListGroupStatsRequest

getDescriptor()

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

newBuilder()

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

newBuilder(ListGroupStatsRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAlignment()

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

Returns
Type Description
TimedCountAlignment

The alignment.

getAlignmentTime()

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.

getAlignmentTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getAlignmentValue()

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.

getDefaultInstanceForType()

public ListGroupStatsRequest getDefaultInstanceForType()
Returns
Type Description
ListGroupStatsRequest

getGroupId(int index)

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.

getGroupIdBytes(int 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.

getGroupIdCount()

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.

getGroupIdList()

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

Returns
Type Description
ProtocolStringList

A list containing the groupId.

getOrder()

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

Returns
Type Description
ErrorGroupOrder

The order.

getOrderValue()

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()

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

getParserForType()

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

getProjectName()

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.

getProjectNameBytes()

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceFilter()

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

Returns
Type Description
ServiceContextFilter

The serviceFilter.

getServiceFilterOrBuilder()

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

Returns
Type Description
ServiceContextFilterOrBuilder

getTimeRange()

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

Returns
Type Description
QueryTimeRange

The timeRange.

getTimeRangeOrBuilder()

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

Returns
Type Description
QueryTimeRangeOrBuilder

getTimedCountDuration()

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.

getTimedCountDurationOrBuilder()

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

Returns
Type Description
DurationOrBuilder

hasAlignmentTime()

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.

hasServiceFilter()

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.

hasTimeRange()

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.

hasTimedCountDuration()

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListGroupStatsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListGroupStatsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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