Package com.google.analytics.admin.v1alpha

Interface ReportingDataAnnotationOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ReportingDataAnnotation, ReportingDataAnnotation.Builder
@Generated public interface ReportingDataAnnotationOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasAnnotationDate

      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:
      Whether the annotationDate field is set.

    • getAnnotationDate

      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:
      The annotationDate.

    • getAnnotationDateOrBuilder

      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;

    • hasAnnotationDateRange

      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:
      Whether the annotationDateRange field is set.

    • getAnnotationDateRange

      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:
      The annotationDateRange.

    • getAnnotationDateRangeOrBuilder

      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;

    • getName

      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:
      The name.

    • getNameBytes

      com.google.protobuf.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:
      The bytes for name.

    • getTitle

      String getTitle()
       Required. Human-readable title for this Reporting Data Annotation.
      string title = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The title.

    • getTitleBytes

      com.google.protobuf.ByteString getTitleBytes()
       Required. Human-readable title for this Reporting Data Annotation.
      string title = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for title.

    • getDescription

      String getDescription()
       Optional. Description for this Reporting Data Annotation.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Description for this Reporting Data Annotation.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.

    • getColorValue

      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:
      The enum numeric value on the wire for color.

    • getColor

      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:
      The color.

    • getSystemGenerated

      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:
      The systemGenerated.

    • getTargetCase

      ReportingDataAnnotation.TargetCase getTargetCase()