Class TimeInterval (3.50.0)

public final class TimeInterval extends GeneratedMessageV3 implements TimeIntervalOrBuilder

Describes a time interval:

  • Reads: A half-open time interval. It includes the end time but excludes the start time: (startTime, endTime]. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric.
  • Writes: A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind of the metric value. The end time must not be earlier than the start time, and the end time must not be more than 25 hours in the past or more than five minutes in the future.
    • For GAUGE metrics, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval.
    • For DELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For DELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval.
    • For CUMULATIVE metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. The new start time must be at least a millisecond after the end time of the previous interval.
    • The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time.

Protobuf type google.monitoring.v3.TimeInterval

Static Fields

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TimeInterval getDefaultInstance()
Returns
Type Description
TimeInterval

getDescriptor()

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

newBuilder()

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

newBuilder(TimeInterval prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public TimeInterval getDefaultInstanceForType()
Returns
Type Description
TimeInterval

getEndTime()

public Timestamp getEndTime()

Required. The end of the time interval.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Required. The end of the time interval.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
TimestampOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

public Timestamp getStartTime()

Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
TimestampOrBuilder

hasEndTime()

public boolean hasEndTime()

Required. The end of the time interval.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
boolean

Whether the endTime field is set.

hasStartTime()

public boolean hasStartTime()

Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
boolean

Whether the startTime 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 TimeInterval.Builder newBuilderForType()
Returns
Type Description
TimeInterval.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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