# Interface ReportingDataAnnotationOrBuilder (0.101.0)

0.101.0 (latest) 0.98.0 0.97.0 0.95.0 0.93.0 0.92.0 0.91.0 0.90.0 0.88.0 0.86.0 0.85.0 0.84.0 0.83.0 0.82.0 0.80.0 0.78.0 0.77.0 0.74.0 0.73.0 0.72.0 0.70.0 0.69.0 0.68.0 0.67.0 0.66.0 0.65.0 0.64.0 0.63.0 0.62.0 0.61.0 0.59.0 0.58.0 0.57.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.47.0 0.46.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.34.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0

    public interface ReportingDataAnnotationOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## 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** |
| `https://docs.cloud.google.com/java/docs/reference/google-analytics-admin/latest/com.google.analytics.admin.v1alpha.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** |
| `https://docs.cloud.google.com/java/docs/reference/google-analytics-admin/latest/com.google.analytics.admin.v1alpha.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** |
| `https://docs.cloud.google.com/java/docs/reference/google-analytics-admin/latest/com.google.analytics.admin.v1alpha.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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The systemGenerated. |

### getTargetCase()

    public abstract ReportingDataAnnotation.TargetCase getTargetCase()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-analytics-admin/latest/com.google.analytics.admin.v1alpha.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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the annotationDateRange field is set. |