Class ListReportingDataAnnotationsRequest (0.86.0)
public final class ListReportingDataAnnotationsRequest extends GeneratedMessageV3 implements ListReportingDataAnnotationsRequestOrBuilder
Request message for ListReportingDataAnnotation RPC.
Protobuf type google.analytics.admin.v1alpha.ListReportingDataAnnotationsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ListReportingDataAnnotationsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListReportingDataAnnotationsRequest.Builder newBuilder()
newBuilder(ListReportingDataAnnotationsRequest prototype)
public static ListReportingDataAnnotationsRequest.Builder newBuilder(ListReportingDataAnnotationsRequest prototype)
public static ListReportingDataAnnotationsRequest parseDelimitedFrom(InputStream input)
public static ListReportingDataAnnotationsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListReportingDataAnnotationsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListReportingDataAnnotationsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListReportingDataAnnotationsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListReportingDataAnnotationsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListReportingDataAnnotationsRequest parseFrom(CodedInputStream input)
public static ListReportingDataAnnotationsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListReportingDataAnnotationsRequest parseFrom(InputStream input)
public static ListReportingDataAnnotationsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListReportingDataAnnotationsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListReportingDataAnnotationsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListReportingDataAnnotationsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ListReportingDataAnnotationsRequest getDefaultInstanceForType()
getFilter()
public String getFilter()
Optional. Filter that restricts which reporting data annotations under the
parent property are listed.
Supported fields are:
- 'name'
titledescriptionannotation_dateannotation_date_rangecolor
Additionally, this API provides the following helper functions:
annotation_duration() : the duration that this annotation marks,
durations.
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
match!~ : regular expression
does not matchNOT : Logical notAND : Logical andOR : Logical or
Examples:
title="Holiday Sale"
description=~"[Bb]ig [Gg]ame.*[Ss]ale"is_annotation_in_range("2025-12-25", "2026-01-16") = trueannotation_duration() >= 172800s AND title:BOGO
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The filter.
|
getFilterBytes()
public ByteString getFilterBytes()
Optional. Filter that restricts which reporting data annotations under the
parent property are listed.
Supported fields are:
- 'name'
titledescriptionannotation_dateannotation_date_rangecolor
Additionally, this API provides the following helper functions:
annotation_duration() : the duration that this annotation marks,
durations.
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
match!~ : regular expression
does not matchNOT : Logical notAND : Logical andOR : Logical or
Examples:
title="Holiday Sale"
description=~"[Bb]ig [Gg]ame.*[Ss]ale"is_annotation_in_range("2025-12-25", "2026-01-16") = trueannotation_duration() >= 172800s AND title:BOGO
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for filter.
|
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];
| Returns |
| Type |
Description |
int |
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];
| Returns |
| Type |
Description |
String |
The pageToken.
|
getPageTokenBytes()
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for pageToken.
|
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) = { ... }
| Returns |
| Type |
Description |
String |
The parent.
|
getParentBytes()
public 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) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for parent.
|
getParserForType()
public Parser<ListReportingDataAnnotationsRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ListReportingDataAnnotationsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListReportingDataAnnotationsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ListReportingDataAnnotationsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-10 UTC."],[],[]]
