Class ReportingDataAnnotation

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.analytics.admin.v1alpha.ReportingDataAnnotation
All Implemented Interfaces:
ReportingDataAnnotationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class ReportingDataAnnotation extends com.google.protobuf.GeneratedMessage implements ReportingDataAnnotationOrBuilder
 A Reporting Data Annotation is a comment connected to certain dates for
 reporting data.
 
Protobuf type google.analytics.admin.v1alpha.ReportingDataAnnotation
See Also:
  • Field Details

    • ANNOTATION_DATE_FIELD_NUMBER

      public static final int ANNOTATION_DATE_FIELD_NUMBER
      See Also:
    • ANNOTATION_DATE_RANGE_FIELD_NUMBER

      public static final int ANNOTATION_DATE_RANGE_FIELD_NUMBER
      See Also:
    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:
    • TITLE_FIELD_NUMBER

      public static final int TITLE_FIELD_NUMBER
      See Also:
    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:
    • COLOR_FIELD_NUMBER

      public static final int COLOR_FIELD_NUMBER
      See Also:
    • SYSTEM_GENERATED_FIELD_NUMBER

      public static final int SYSTEM_GENERATED_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getTargetCase

      public ReportingDataAnnotation.TargetCase getTargetCase()
      Specified by:
      getTargetCase in interface ReportingDataAnnotationOrBuilder
    • 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;
      Specified by:
      hasAnnotationDate in interface ReportingDataAnnotationOrBuilder
      Returns:
      Whether the annotationDate field is set.
    • 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;
      Specified by:
      getAnnotationDate in interface ReportingDataAnnotationOrBuilder
      Returns:
      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;
      Specified by:
      getAnnotationDateOrBuilder in interface ReportingDataAnnotationOrBuilder
    • 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;
      Specified by:
      hasAnnotationDateRange in interface ReportingDataAnnotationOrBuilder
      Returns:
      Whether the annotationDateRange field is set.
    • 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;
      Specified by:
      getAnnotationDateRange in interface ReportingDataAnnotationOrBuilder
      Returns:
      The annotationDateRange.
    • 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;
      Specified by:
      getAnnotationDateRangeOrBuilder in interface ReportingDataAnnotationOrBuilder
    • 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];
      Specified by:
      getName in interface ReportingDataAnnotationOrBuilder
      Returns:
      The name.
    • getNameBytes

      public 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];
      Specified by:
      getNameBytes in interface ReportingDataAnnotationOrBuilder
      Returns:
      The bytes for name.
    • getTitle

      public String getTitle()
       Required. Human-readable title for this Reporting Data Annotation.
       
      string title = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getTitle in interface ReportingDataAnnotationOrBuilder
      Returns:
      The title.
    • getTitleBytes

      public com.google.protobuf.ByteString getTitleBytes()
       Required. Human-readable title for this Reporting Data Annotation.
       
      string title = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getTitleBytes in interface ReportingDataAnnotationOrBuilder
      Returns:
      The bytes for title.
    • getDescription

      public String getDescription()
       Optional. Description for this Reporting Data Annotation.
       
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescription in interface ReportingDataAnnotationOrBuilder
      Returns:
      The description.
    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Description for this Reporting Data Annotation.
       
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescriptionBytes in interface ReportingDataAnnotationOrBuilder
      Returns:
      The bytes for description.
    • 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];
      Specified by:
      getColorValue in interface ReportingDataAnnotationOrBuilder
      Returns:
      The enum numeric value on the wire for color.
    • 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];
      Specified by:
      getColor in interface ReportingDataAnnotationOrBuilder
      Returns:
      The color.
    • 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];
      Specified by:
      getSystemGenerated in interface ReportingDataAnnotationOrBuilder
      Returns:
      The systemGenerated.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static ReportingDataAnnotation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ReportingDataAnnotation parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ReportingDataAnnotation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ReportingDataAnnotation parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ReportingDataAnnotation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ReportingDataAnnotation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ReportingDataAnnotation parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ReportingDataAnnotation parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static ReportingDataAnnotation parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static ReportingDataAnnotation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ReportingDataAnnotation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ReportingDataAnnotation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public ReportingDataAnnotation.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static ReportingDataAnnotation.Builder newBuilder()
    • newBuilder

      public static ReportingDataAnnotation.Builder newBuilder(ReportingDataAnnotation prototype)
    • toBuilder

      public ReportingDataAnnotation.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected ReportingDataAnnotation.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static ReportingDataAnnotation getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<ReportingDataAnnotation> parser()
    • getParserForType

      public com.google.protobuf.Parser<ReportingDataAnnotation> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public ReportingDataAnnotation getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder