public final class ReportingDataAnnotation extends GeneratedMessageV3 implements ReportingDataAnnotationOrBuilder
A Reporting Data Annotation is a comment connected to certain dates for
reporting data.
Protobuf type google.analytics.admin.v1alpha.ReportingDataAnnotation
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
ANNOTATION_DATE_FIELD_NUMBER
public static final int ANNOTATION_DATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ANNOTATION_DATE_RANGE_FIELD_NUMBER
public static final int ANNOTATION_DATE_RANGE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
COLOR_FIELD_NUMBER
public static final int COLOR_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SYSTEM_GENERATED_FIELD_NUMBER
public static final int SYSTEM_GENERATED_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TITLE_FIELD_NUMBER
public static final int TITLE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ReportingDataAnnotation getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ReportingDataAnnotation.Builder newBuilder()
newBuilder(ReportingDataAnnotation prototype)
public static ReportingDataAnnotation.Builder newBuilder(ReportingDataAnnotation prototype)
public static ReportingDataAnnotation parseDelimitedFrom(InputStream input)
public static ReportingDataAnnotation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ReportingDataAnnotation parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ReportingDataAnnotation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ReportingDataAnnotation parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ReportingDataAnnotation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ReportingDataAnnotation parseFrom(CodedInputStream input)
public static ReportingDataAnnotation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ReportingDataAnnotation parseFrom(InputStream input)
public static ReportingDataAnnotation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ReportingDataAnnotation parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ReportingDataAnnotation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ReportingDataAnnotation> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAnnotationDate()
public Date getAnnotationDate()
If set, the Reporting Data Annotation is for a specific date represented
by this field. The date must be a valid date with year, month and day
set. The date may be in the past, present, or future.
.google.type.Date annotation_date = 4;
| Returns |
| Type |
Description |
com.google.type.Date |
The annotationDate.
|
getAnnotationDateOrBuilder()
public DateOrBuilder getAnnotationDateOrBuilder()
If set, the Reporting Data Annotation is for a specific date represented
by this field. The date must be a valid date with year, month and day
set. The date may be in the past, present, or future.
.google.type.Date annotation_date = 4;
| Returns |
| Type |
Description |
com.google.type.DateOrBuilder |
|
getAnnotationDateRange()
public ReportingDataAnnotation.DateRange getAnnotationDateRange()
If set, the Reporting Data Annotation is for a range of dates represented
by this field.
.google.analytics.admin.v1alpha.ReportingDataAnnotation.DateRange annotation_date_range = 5;
getAnnotationDateRangeOrBuilder()
public ReportingDataAnnotation.DateRangeOrBuilder getAnnotationDateRangeOrBuilder()
If set, the Reporting Data Annotation is for a range of dates represented
by this field.
.google.analytics.admin.v1alpha.ReportingDataAnnotation.DateRange annotation_date_range = 5;
getColor()
public ReportingDataAnnotation.Color getColor()
Required. The color used for display of this Reporting Data Annotation.
.google.analytics.admin.v1alpha.ReportingDataAnnotation.Color color = 6 [(.google.api.field_behavior) = REQUIRED];
getColorValue()
public int getColorValue()
Required. The color used for display of this Reporting Data Annotation.
.google.analytics.admin.v1alpha.ReportingDataAnnotation.Color color = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for color.
|
getDefaultInstanceForType()
public ReportingDataAnnotation getDefaultInstanceForType()
getDescription()
public String getDescription()
Optional. Description for this Reporting Data Annotation.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. Description for this Reporting Data Annotation.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
getName()
Required. Identifier. Resource name of this Reporting Data Annotation.
Format:
'properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}'
Format: 'properties/123/reportingDataAnnotations/456'
string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Required. Identifier. Resource name of this Reporting Data Annotation.
Format:
'properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}'
Format: 'properties/123/reportingDataAnnotations/456'
string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<ReportingDataAnnotation> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSystemGenerated()
public boolean getSystemGenerated()
Output only. If true, this annotation was generated by the Google Analytics
system. System-generated annotations cannot be updated or deleted.
bool system_generated = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
The systemGenerated.
|
getTargetCase()
public ReportingDataAnnotation.TargetCase getTargetCase()
getTitle()
Required. Human-readable title for this Reporting Data Annotation.
string title = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The title.
|
getTitleBytes()
public ByteString getTitleBytes()
Required. Human-readable title for this Reporting Data Annotation.
string title = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for title.
|
hasAnnotationDate()
public boolean hasAnnotationDate()
If set, the Reporting Data Annotation is for a specific date represented
by this field. The date must be a valid date with year, month and day
set. The date may be in the past, present, or future.
.google.type.Date annotation_date = 4;
| Returns |
| Type |
Description |
boolean |
Whether the annotationDate field is set.
|
hasAnnotationDateRange()
public boolean hasAnnotationDateRange()
If set, the Reporting Data Annotation is for a range of dates represented
by this field.
.google.analytics.admin.v1alpha.ReportingDataAnnotation.DateRange annotation_date_range = 5;
| Returns |
| Type |
Description |
boolean |
Whether the annotationDateRange field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ReportingDataAnnotation.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ReportingDataAnnotation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ReportingDataAnnotation.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
