public static final class CohortsRange.Builder extends GeneratedMessageV3.Builder<CohortsRange.Builder> implements CohortsRangeOrBuilder
Configures the extended reporting date range for a cohort report. Specifies
an offset duration to follow the cohorts over.
Protobuf type google.analytics.data.v1beta.CohortsRange
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CohortsRange.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public CohortsRange build()
Returns
buildPartial()
public CohortsRange buildPartial()
Returns
clear()
public CohortsRange.Builder clear()
Returns
Overrides
clearEndOffset()
public CohortsRange.Builder clearEndOffset()
Required. endOffset
specifies the end date of the extended reporting date
range for a cohort report. endOffset
can be any positive integer but is
commonly set to 5 to 10 so that reports contain data on the cohort for the
next several granularity time periods.
If granularity
is DAILY
, the endDate
of the extended reporting date
range is endDate
of the cohort plus endOffset
days.
If granularity
is WEEKLY
, the endDate
of the extended reporting date
range is endDate
of the cohort plus endOffset * 7
days.
If granularity
is MONTHLY
, the endDate
of the extended reporting date
range is endDate
of the cohort plus endOffset * 30
days.
int32 end_offset = 3;
Returns
clearField(Descriptors.FieldDescriptor field)
public CohortsRange.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearGranularity()
public CohortsRange.Builder clearGranularity()
Required. The granularity used to interpret the startOffset
and
endOffset
for the extended reporting date range for a cohort report.
.google.analytics.data.v1beta.CohortsRange.Granularity granularity = 1;
Returns
clearOneof(Descriptors.OneofDescriptor oneof)
public CohortsRange.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clearStartOffset()
public CohortsRange.Builder clearStartOffset()
startOffset
specifies the start date of the extended reporting date range
for a cohort report. startOffset
is commonly set to 0 so that reports
contain data from the acquisition of the cohort forward.
If granularity
is DAILY
, the startDate
of the extended reporting date
range is startDate
of the cohort plus startOffset
days.
If granularity
is WEEKLY
, the startDate
of the extended reporting
date range is startDate
of the cohort plus startOffset * 7
days.
If granularity
is MONTHLY
, the startDate
of the extended reporting
date range is startDate
of the cohort plus startOffset * 30
days.
int32 start_offset = 2;
Returns
clone()
public CohortsRange.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public CohortsRange getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getEndOffset()
public int getEndOffset()
Required. endOffset
specifies the end date of the extended reporting date
range for a cohort report. endOffset
can be any positive integer but is
commonly set to 5 to 10 so that reports contain data on the cohort for the
next several granularity time periods.
If granularity
is DAILY
, the endDate
of the extended reporting date
range is endDate
of the cohort plus endOffset
days.
If granularity
is WEEKLY
, the endDate
of the extended reporting date
range is endDate
of the cohort plus endOffset * 7
days.
If granularity
is MONTHLY
, the endDate
of the extended reporting date
range is endDate
of the cohort plus endOffset * 30
days.
int32 end_offset = 3;
Returns
Type | Description |
int | The endOffset.
|
getGranularity()
public CohortsRange.Granularity getGranularity()
Required. The granularity used to interpret the startOffset
and
endOffset
for the extended reporting date range for a cohort report.
.google.analytics.data.v1beta.CohortsRange.Granularity granularity = 1;
Returns
getGranularityValue()
public int getGranularityValue()
Required. The granularity used to interpret the startOffset
and
endOffset
for the extended reporting date range for a cohort report.
.google.analytics.data.v1beta.CohortsRange.Granularity granularity = 1;
Returns
Type | Description |
int | The enum numeric value on the wire for granularity.
|
getStartOffset()
public int getStartOffset()
startOffset
specifies the start date of the extended reporting date range
for a cohort report. startOffset
is commonly set to 0 so that reports
contain data from the acquisition of the cohort forward.
If granularity
is DAILY
, the startDate
of the extended reporting date
range is startDate
of the cohort plus startOffset
days.
If granularity
is WEEKLY
, the startDate
of the extended reporting
date range is startDate
of the cohort plus startOffset * 7
days.
If granularity
is MONTHLY
, the startDate
of the extended reporting
date range is startDate
of the cohort plus startOffset * 30
days.
int32 start_offset = 2;
Returns
Type | Description |
int | The startOffset.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(CohortsRange other)
public CohortsRange.Builder mergeFrom(CohortsRange other)
Parameter
Returns
public CohortsRange.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public CohortsRange.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CohortsRange.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setEndOffset(int value)
public CohortsRange.Builder setEndOffset(int value)
Required. endOffset
specifies the end date of the extended reporting date
range for a cohort report. endOffset
can be any positive integer but is
commonly set to 5 to 10 so that reports contain data on the cohort for the
next several granularity time periods.
If granularity
is DAILY
, the endDate
of the extended reporting date
range is endDate
of the cohort plus endOffset
days.
If granularity
is WEEKLY
, the endDate
of the extended reporting date
range is endDate
of the cohort plus endOffset * 7
days.
If granularity
is MONTHLY
, the endDate
of the extended reporting date
range is endDate
of the cohort plus endOffset * 30
days.
int32 end_offset = 3;
Parameter
Name | Description |
value | int
The endOffset to set.
|
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public CohortsRange.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setGranularity(CohortsRange.Granularity value)
public CohortsRange.Builder setGranularity(CohortsRange.Granularity value)
Required. The granularity used to interpret the startOffset
and
endOffset
for the extended reporting date range for a cohort report.
.google.analytics.data.v1beta.CohortsRange.Granularity granularity = 1;
Parameter
Returns
setGranularityValue(int value)
public CohortsRange.Builder setGranularityValue(int value)
Required. The granularity used to interpret the startOffset
and
endOffset
for the extended reporting date range for a cohort report.
.google.analytics.data.v1beta.CohortsRange.Granularity granularity = 1;
Parameter
Name | Description |
value | int
The enum numeric value on the wire for granularity to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CohortsRange.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setStartOffset(int value)
public CohortsRange.Builder setStartOffset(int value)
startOffset
specifies the start date of the extended reporting date range
for a cohort report. startOffset
is commonly set to 0 so that reports
contain data from the acquisition of the cohort forward.
If granularity
is DAILY
, the startDate
of the extended reporting date
range is startDate
of the cohort plus startOffset
days.
If granularity
is WEEKLY
, the startDate
of the extended reporting
date range is startDate
of the cohort plus startOffset * 7
days.
If granularity
is MONTHLY
, the startDate
of the extended reporting
date range is startDate
of the cohort plus startOffset * 30
days.
int32 start_offset = 2;
Parameter
Name | Description |
value | int
The startOffset to set.
|
Returns
setUnknownFields(UnknownFieldSet unknownFields)
public final CohortsRange.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides