Package com.google.analytics.admin.v1alpha

Class ReportingDataAnnotation.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ReportingDataAnnotation.Builder>
com.google.analytics.admin.v1alpha.ReportingDataAnnotation.Builder
All Implemented Interfaces:
ReportingDataAnnotationOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ReportingDataAnnotation
public static final class ReportingDataAnnotation.Builder extends com.google.protobuf.GeneratedMessage.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

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

    • clear

      public ReportingDataAnnotation.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ReportingDataAnnotation.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ReportingDataAnnotation.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public ReportingDataAnnotation.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ReportingDataAnnotation.Builder>

    • mergeFrom

      public ReportingDataAnnotation.Builder mergeFrom(ReportingDataAnnotation other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ReportingDataAnnotation.Builder>

    • mergeFrom

      public ReportingDataAnnotation.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ReportingDataAnnotation.Builder>
      Throws:
      IOException

    • getTargetCase

      public ReportingDataAnnotation.TargetCase getTargetCase()
      Specified by:
      getTargetCase in interface ReportingDataAnnotationOrBuilder

    • clearTarget

      public ReportingDataAnnotation.Builder clearTarget()

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

    • setAnnotationDate

      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;

    • setAnnotationDate

      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;

    • mergeAnnotationDate

      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;

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

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

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

    • setAnnotationDateRange

      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;

    • setAnnotationDateRange

      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;

    • mergeAnnotationDateRange

      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;

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

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

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

    • setName

      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];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

    • setNameBytes

      public ReportingDataAnnotation.Builder setNameBytes(com.google.protobuf.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];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

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

    • setTitle

      public ReportingDataAnnotation.Builder setTitle(String value)
       Required. Human-readable title for this Reporting Data Annotation.
      string title = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The title to set.
      Returns:
      This builder for chaining.

    • clearTitle

      public ReportingDataAnnotation.Builder clearTitle()
       Required. Human-readable title for this Reporting Data Annotation.
      string title = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setTitleBytes

      public ReportingDataAnnotation.Builder setTitleBytes(com.google.protobuf.ByteString value)
       Required. Human-readable title for this Reporting Data Annotation.
      string title = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for title to set.
      Returns:
      This builder for chaining.

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

    • setDescription

      public ReportingDataAnnotation.Builder setDescription(String value)
       Optional. Description for this Reporting Data Annotation.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The description to set.
      Returns:
      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:
      This builder for chaining.

    • setDescriptionBytes

      public ReportingDataAnnotation.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
       Optional. Description for this Reporting Data Annotation.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.

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

    • setColorValue

      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];
      Parameters:
      value - The enum numeric value on the wire for color to set.
      Returns:
      This builder for chaining.

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

    • setColor

      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];
      Parameters:
      value - The color to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

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

    • setSystemGenerated

      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];
      Parameters:
      value - The systemGenerated to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.