Class ReportingDataAnnotation.Builder (0.72.0)

public static final class ReportingDataAnnotation.Builder extends GeneratedMessageV3.Builder<ReportingDataAnnotation.Builder> implements ReportingDataAnnotationOrBuilder

A Reporting Data Annotation is a comment connected to certain dates for reporting data.

Protobuf type google.analytics.admin.v1alpha.ReportingDataAnnotation

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ReportingDataAnnotation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ReportingDataAnnotation.Builder
Overrides

build()

public ReportingDataAnnotation build()
Returns
Type Description
ReportingDataAnnotation

buildPartial()

public ReportingDataAnnotation buildPartial()
Returns
Type Description
ReportingDataAnnotation

clear()

public ReportingDataAnnotation.Builder clear()
Returns
Type Description
ReportingDataAnnotation.Builder
Overrides

clearAnnotationDate()

public ReportingDataAnnotation.Builder clearAnnotationDate()

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
ReportingDataAnnotation.Builder

clearAnnotationDateRange()

public ReportingDataAnnotation.Builder clearAnnotationDateRange()

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
ReportingDataAnnotation.Builder

clearColor()

public ReportingDataAnnotation.Builder clearColor()

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
ReportingDataAnnotation.Builder

This builder for chaining.

clearDescription()

public ReportingDataAnnotation.Builder clearDescription()

Optional. Description for this Reporting Data Annotation.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ReportingDataAnnotation.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ReportingDataAnnotation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ReportingDataAnnotation.Builder
Overrides

clearName()

public ReportingDataAnnotation.Builder clearName()

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
ReportingDataAnnotation.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ReportingDataAnnotation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ReportingDataAnnotation.Builder
Overrides

clearSystemGenerated()

public ReportingDataAnnotation.Builder clearSystemGenerated()

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
ReportingDataAnnotation.Builder

This builder for chaining.

clearTarget()

public ReportingDataAnnotation.Builder clearTarget()
Returns
Type Description
ReportingDataAnnotation.Builder

clearTitle()

public ReportingDataAnnotation.Builder clearTitle()

Required. Human-readable title for this Reporting Data Annotation.

string title = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReportingDataAnnotation.Builder

This builder for chaining.

clone()

public ReportingDataAnnotation.Builder clone()
Returns
Type Description
ReportingDataAnnotation.Builder
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.

getAnnotationDateBuilder()

public Date.Builder getAnnotationDateBuilder()

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

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;

Returns
Type Description
ReportingDataAnnotation.DateRange

The annotationDateRange.

getAnnotationDateRangeBuilder()

public ReportingDataAnnotation.DateRange.Builder getAnnotationDateRangeBuilder()

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
ReportingDataAnnotation.DateRange.Builder

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;

Returns
Type Description
ReportingDataAnnotation.DateRangeOrBuilder

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

Returns
Type Description
ReportingDataAnnotation.Color

The color.

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()
Returns
Type Description
ReportingDataAnnotation

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getName()

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

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()
Returns
Type Description
ReportingDataAnnotation.TargetCase

getTitle()

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAnnotationDate(Date value)

public ReportingDataAnnotation.Builder mergeAnnotationDate(Date value)

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;

Parameter
Name Description
value com.google.type.Date
Returns
Type Description
ReportingDataAnnotation.Builder

mergeAnnotationDateRange(ReportingDataAnnotation.DateRange value)

public ReportingDataAnnotation.Builder mergeAnnotationDateRange(ReportingDataAnnotation.DateRange value)

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;

Parameter
Name Description
value ReportingDataAnnotation.DateRange
Returns
Type Description
ReportingDataAnnotation.Builder

mergeFrom(ReportingDataAnnotation other)

public ReportingDataAnnotation.Builder mergeFrom(ReportingDataAnnotation other)
Parameter
Name Description
other ReportingDataAnnotation
Returns
Type Description
ReportingDataAnnotation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReportingDataAnnotation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportingDataAnnotation.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ReportingDataAnnotation.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ReportingDataAnnotation.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReportingDataAnnotation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ReportingDataAnnotation.Builder
Overrides

setAnnotationDate(Date value)

public ReportingDataAnnotation.Builder setAnnotationDate(Date value)

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;

Parameter
Name Description
value com.google.type.Date
Returns
Type Description
ReportingDataAnnotation.Builder

setAnnotationDate(Date.Builder builderForValue)

public ReportingDataAnnotation.Builder setAnnotationDate(Date.Builder builderForValue)

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;

Parameter
Name Description
builderForValue com.google.type.Date.Builder
Returns
Type Description
ReportingDataAnnotation.Builder

setAnnotationDateRange(ReportingDataAnnotation.DateRange value)

public ReportingDataAnnotation.Builder setAnnotationDateRange(ReportingDataAnnotation.DateRange value)

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;

Parameter
Name Description
value ReportingDataAnnotation.DateRange
Returns
Type Description
ReportingDataAnnotation.Builder

setAnnotationDateRange(ReportingDataAnnotation.DateRange.Builder builderForValue)

public ReportingDataAnnotation.Builder setAnnotationDateRange(ReportingDataAnnotation.DateRange.Builder builderForValue)

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;

Parameter
Name Description
builderForValue ReportingDataAnnotation.DateRange.Builder
Returns
Type Description
ReportingDataAnnotation.Builder

setColor(ReportingDataAnnotation.Color value)

public ReportingDataAnnotation.Builder setColor(ReportingDataAnnotation.Color value)

Required. The color used for display of this Reporting Data Annotation.

.google.analytics.admin.v1alpha.ReportingDataAnnotation.Color color = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ReportingDataAnnotation.Color

The color to set.

Returns
Type Description
ReportingDataAnnotation.Builder

This builder for chaining.

setColorValue(int value)

public ReportingDataAnnotation.Builder setColorValue(int value)

Required. The color used for display of this Reporting Data Annotation.

.google.analytics.admin.v1alpha.ReportingDataAnnotation.Color color = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for color to set.

Returns
Type Description
ReportingDataAnnotation.Builder

This builder for chaining.

setDescription(String value)

public ReportingDataAnnotation.Builder setDescription(String value)

Optional. Description for this Reporting Data Annotation.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.

Returns
Type Description
ReportingDataAnnotation.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public ReportingDataAnnotation.Builder setDescriptionBytes(ByteString value)

Optional. Description for this Reporting Data Annotation.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
ReportingDataAnnotation.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ReportingDataAnnotation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ReportingDataAnnotation.Builder
Overrides

setName(String value)

public ReportingDataAnnotation.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
ReportingDataAnnotation.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ReportingDataAnnotation.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
ReportingDataAnnotation.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ReportingDataAnnotation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ReportingDataAnnotation.Builder
Overrides

setSystemGenerated(boolean value)

public ReportingDataAnnotation.Builder setSystemGenerated(boolean value)

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

Parameter
Name Description
value boolean

The systemGenerated to set.

Returns
Type Description
ReportingDataAnnotation.Builder

This builder for chaining.

setTitle(String value)

public ReportingDataAnnotation.Builder setTitle(String value)

Required. Human-readable title for this Reporting Data Annotation.

string title = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The title to set.

Returns
Type Description
ReportingDataAnnotation.Builder

This builder for chaining.

setTitleBytes(ByteString value)

public ReportingDataAnnotation.Builder setTitleBytes(ByteString value)

Required. Human-readable title for this Reporting Data Annotation.

string title = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for title to set.

Returns
Type Description
ReportingDataAnnotation.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ReportingDataAnnotation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ReportingDataAnnotation.Builder
Overrides