- 0.70.0 (latest)
- 0.69.0
- 0.68.0
- 0.67.0
- 0.66.0
- 0.65.0
- 0.64.0
- 0.63.0
- 0.62.0
- 0.61.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
public static final class ListReportingDataAnnotationsRequest.Builder extends GeneratedMessageV3.Builder<ListReportingDataAnnotationsRequest.Builder> implements ListReportingDataAnnotationsRequestOrBuilderRequest message for ListReportingDataAnnotation RPC.
Protobuf type google.analytics.admin.v1alpha.ListReportingDataAnnotationsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListReportingDataAnnotationsRequest.BuilderImplements
ListReportingDataAnnotationsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListReportingDataAnnotationsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest.Builder |
|
build()
public ListReportingDataAnnotationsRequest build()| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest |
|
buildPartial()
public ListReportingDataAnnotationsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest |
|
clear()
public ListReportingDataAnnotationsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ListReportingDataAnnotationsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest.Builder |
|
clearFilter()
public ListReportingDataAnnotationsRequest.Builder clearFilter()Optional. Filter that restricts which reporting data annotations under the parent property are listed.
Supported fields are:
- 'name'
titledescriptionannotation_dateannotation_date_rangecolorAdditionally, 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
ssuffix.is_annotation_in_range(start_date, end_date) : if the annotation is in the range specified by the
start_dateandend_date. The dates are in ISO-8601 format, for example2031-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 |
ListReportingDataAnnotationsRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListReportingDataAnnotationsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest.Builder |
|
clearPageSize()
public ListReportingDataAnnotationsRequest.Builder clearPageSize()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 |
ListReportingDataAnnotationsRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListReportingDataAnnotationsRequest.Builder clearPageToken() 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 |
ListReportingDataAnnotationsRequest.Builder |
This builder for chaining. |
clearParent()
public ListReportingDataAnnotationsRequest.Builder clearParent()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 |
ListReportingDataAnnotationsRequest.Builder |
This builder for chaining. |
clone()
public ListReportingDataAnnotationsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest.Builder |
|
getDefaultInstanceForType()
public ListReportingDataAnnotationsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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_rangecolorAdditionally, 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
ssuffix.is_annotation_in_range(start_date, end_date) : if the annotation is in the range specified by the
start_dateandend_date. The dates are in ISO-8601 format, for example2031-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_rangecolorAdditionally, 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
ssuffix.is_annotation_in_range(start_date, end_date) : if the annotation is in the range specified by the
start_dateandend_date. The dates are in ISO-8601 format, for example2031-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()
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];
| 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ListReportingDataAnnotationsRequest other)
public ListReportingDataAnnotationsRequest.Builder mergeFrom(ListReportingDataAnnotationsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListReportingDataAnnotationsRequest |
| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListReportingDataAnnotationsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListReportingDataAnnotationsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListReportingDataAnnotationsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ListReportingDataAnnotationsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest.Builder |
|
setFilter(String value)
public ListReportingDataAnnotationsRequest.Builder setFilter(String value)Optional. Filter that restricts which reporting data annotations under the parent property are listed.
Supported fields are:
- 'name'
titledescriptionannotation_dateannotation_date_rangecolorAdditionally, 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
ssuffix.is_annotation_in_range(start_date, end_date) : if the annotation is in the range specified by the
start_dateandend_date. The dates are in ISO-8601 format, for example2031-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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListReportingDataAnnotationsRequest.Builder setFilterBytes(ByteString value)Optional. Filter that restricts which reporting data annotations under the parent property are listed.
Supported fields are:
- 'name'
titledescriptionannotation_dateannotation_date_rangecolorAdditionally, 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
ssuffix.is_annotation_in_range(start_date, end_date) : if the annotation is in the range specified by the
start_dateandend_date. The dates are in ISO-8601 format, for example2031-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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListReportingDataAnnotationsRequest.Builder setPageSize(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListReportingDataAnnotationsRequest.Builder setPageToken(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListReportingDataAnnotationsRequest.Builder setPageTokenBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListReportingDataAnnotationsRequest.Builder setParent(String value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListReportingDataAnnotationsRequest.Builder setParentBytes(ByteString value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListReportingDataAnnotationsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ListReportingDataAnnotationsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListReportingDataAnnotationsRequest.Builder |
|