Package com.google.analytics.admin.v1alpha

Class ListReportingDataAnnotationsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.analytics.admin.v1alpha.ListReportingDataAnnotationsRequest
All Implemented Interfaces:
ListReportingDataAnnotationsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ListReportingDataAnnotationsRequest extends com.google.protobuf.GeneratedMessage implements ListReportingDataAnnotationsRequestOrBuilder
 Request message for ListReportingDataAnnotation RPC.
Protobuf type google.analytics.admin.v1alpha.ListReportingDataAnnotationsRequest
See Also:

  • Field Details

  • 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

    • getParent

      public String getParent()
       Required. Resource name of the property.
 Format: properties/property_id
 Example: properties/123
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface ListReportingDataAnnotationsRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. Resource name of the property.
 Format: properties/property_id
 Example: properties/123
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface ListReportingDataAnnotationsRequestOrBuilder
      Returns:
      The bytes for parent.

    • getFilter

      public String getFilter()
       Optional. Filter that restricts which reporting data annotations under the
 parent property are listed.

 Supported fields are:

 * 'name'
 * `title`
 * `description`
 * `annotation_date`
 * `annotation_date_range`
 * `color`

 Additionally, this API provides the following helper functions:

 * annotation_duration() : the duration that this annotation marks,
 [durations](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/duration.proto).
 expect a numeric representation of seconds followed by an `s` suffix.
 * is_annotation_in_range(start_date, end_date)  : if the annotation is in
 the range specified by the `start_date` and `end_date`. The dates are in
 ISO-8601 format, for example `2031-06-28`.

 Supported operations:

 * `=` : equals
 * `!=` : not equals
 * `<` : less than
 * `>` : greater than
 * `<=` :  less than or equals
 * `>=` : greater than or equals
 * `:` : has operator
 * `=~` : [regular expression](https://github.com/google/re2/wiki/Syntax)
 match
 * `!~` : [regular expression](https://github.com/google/re2/wiki/Syntax)
 does not match
 * `NOT` : Logical not
 * `AND` : Logical and
 * `OR` : Logical or

 Examples:

 1. `title="Holiday Sale"`
 2. `description=~"[Bb]ig [Gg]ame.*[Ss]ale"`
 3. `is_annotation_in_range("2025-12-25", "2026-01-16") = true`
 4. `annotation_duration() >= 172800s AND title:BOGO`
      string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilter in interface ListReportingDataAnnotationsRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       Optional. Filter that restricts which reporting data annotations under the
 parent property are listed.

 Supported fields are:

 * 'name'
 * `title`
 * `description`
 * `annotation_date`
 * `annotation_date_range`
 * `color`

 Additionally, this API provides the following helper functions:

 * annotation_duration() : the duration that this annotation marks,
 [durations](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/duration.proto).
 expect a numeric representation of seconds followed by an `s` suffix.
 * is_annotation_in_range(start_date, end_date)  : if the annotation is in
 the range specified by the `start_date` and `end_date`. The dates are in
 ISO-8601 format, for example `2031-06-28`.

 Supported operations:

 * `=` : equals
 * `!=` : not equals
 * `<` : less than
 * `>` : greater than
 * `<=` :  less than or equals
 * `>=` : greater than or equals
 * `:` : has operator
 * `=~` : [regular expression](https://github.com/google/re2/wiki/Syntax)
 match
 * `!~` : [regular expression](https://github.com/google/re2/wiki/Syntax)
 does not match
 * `NOT` : Logical not
 * `AND` : Logical and
 * `OR` : Logical or

 Examples:

 1. `title="Holiday Sale"`
 2. `description=~"[Bb]ig [Gg]ame.*[Ss]ale"`
 3. `is_annotation_in_range("2025-12-25", "2026-01-16") = true`
 4. `annotation_duration() >= 172800s AND title:BOGO`
      string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilterBytes in interface ListReportingDataAnnotationsRequestOrBuilder
      Returns:
      The bytes for filter.

    • getPageSize

      public int getPageSize()
       Optional. The maximum number of resources to return. The service may return
 fewer than this value, even if there are additional pages. If unspecified,
 at most 50 resources will be returned. The maximum value is 200; (higher
 values will be coerced to the maximum)
      int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageSize in interface ListReportingDataAnnotationsRequestOrBuilder
      Returns:
      The pageSize.

    • getPageToken

      public String getPageToken()
       Optional. A page token, received from a previous
 `ListReportingDataAnnotations` call. Provide this to retrieve the
 subsequent page. When paginating, all other parameters provided to
 `ListReportingDataAnnotations` must match the call that provided the page
 token.
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageToken in interface ListReportingDataAnnotationsRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       Optional. A page token, received from a previous
 `ListReportingDataAnnotations` call. Provide this to retrieve the
 subsequent page. When paginating, all other parameters provided to
 `ListReportingDataAnnotations` must match the call that provided the page
 token.
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageTokenBytes in interface ListReportingDataAnnotationsRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • 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 ListReportingDataAnnotationsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static ListReportingDataAnnotationsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static ListReportingDataAnnotationsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ListReportingDataAnnotationsRequest.Builder newBuilder()

    • newBuilder

      public static ListReportingDataAnnotationsRequest.Builder newBuilder(ListReportingDataAnnotationsRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ListReportingDataAnnotationsRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ListReportingDataAnnotationsRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<ListReportingDataAnnotationsRequest> 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 ListReportingDataAnnotationsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder