Class DateRange (0.57.0)

public final class DateRange extends GeneratedMessageV3 implements DateRangeOrBuilder

A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.

Protobuf type google.analytics.data.v1alpha.DateRange

Implements

DateRangeOrBuilder

Static Fields

END_DATE_FIELD_NUMBER

public static final int END_DATE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

START_DATE_FIELD_NUMBER

public static final int START_DATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DateRange getDefaultInstance()
Returns
Type Description
DateRange

getDescriptor()

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

newBuilder()

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

newBuilder(DateRange prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public DateRange getDefaultInstanceForType()
Returns
Type Description
DateRange

getEndDate()

public String getEndDate()

The inclusive end date for the query in the format YYYY-MM-DD. Cannot be before start_date. The format NdaysAgo, yesterday, or today is also accepted, and in that case, the date is inferred based on the property's reporting time zone.

string end_date = 2;

Returns
Type Description
String

The endDate.

getEndDateBytes()

public ByteString getEndDateBytes()

The inclusive end date for the query in the format YYYY-MM-DD. Cannot be before start_date. The format NdaysAgo, yesterday, or today is also accepted, and in that case, the date is inferred based on the property's reporting time zone.

string end_date = 2;

Returns
Type Description
ByteString

The bytes for endDate.

getName()

public String getName()

Assigns a name to this date range. The dimension dateRange is valued to this name in a report response. If set, cannot begin with date_range_ or RESERVED_. If not set, date ranges are named by their zero based index in the request: date_range_0, date_range_1, etc.

string name = 3;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Assigns a name to this date range. The dimension dateRange is valued to this name in a report response. If set, cannot begin with date_range_ or RESERVED_. If not set, date ranges are named by their zero based index in the request: date_range_0, date_range_1, etc.

string name = 3;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartDate()

public String getStartDate()

The inclusive start date for the query in the format YYYY-MM-DD. Cannot be after end_date. The format NdaysAgo, yesterday, or today is also accepted, and in that case, the date is inferred based on the property's reporting time zone.

string start_date = 1;

Returns
Type Description
String

The startDate.

getStartDateBytes()

public ByteString getStartDateBytes()

The inclusive start date for the query in the format YYYY-MM-DD. Cannot be after end_date. The format NdaysAgo, yesterday, or today is also accepted, and in that case, the date is inferred based on the property's reporting time zone.

string start_date = 1;

Returns
Type Description
ByteString

The bytes for startDate.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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