Interface ReportingDataAnnotationOrBuilder (0.72.0)

public interface ReportingDataAnnotationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAnnotationDate()

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

getAnnotationDateRangeOrBuilder()

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

getDescription()

public abstract 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 abstract 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()

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

getTitle()

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