Package com.google.analytics.admin.v1alpha

Class ListReportingDataAnnotationsRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<ListReportingDataAnnotationsRequest.Builder>

com.google.analytics.admin.v1alpha.ListReportingDataAnnotationsRequest.Builder

All Implemented Interfaces:

ListReportingDataAnnotationsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ListReportingDataAnnotationsRequest

public static final class ListReportingDataAnnotationsRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ListReportingDataAnnotationsRequest.Builder>
implements ListReportingDataAnnotationsRequestOrBuilder

 Request message for ListReportingDataAnnotation RPC.
 

Protobuf type google.analytics.admin.v1alpha.ListReportingDataAnnotationsRequest

Method Summary

Modifier and Type	Method	Description
ListReportingDataAnnotationsRequest	build()
ListReportingDataAnnotationsRequest	buildPartial()
ListReportingDataAnnotationsRequest.Builder	clear()
ListReportingDataAnnotationsRequest.Builder	clearFilter()	Optional.
ListReportingDataAnnotationsRequest.Builder	clearPageSize()	Optional.
ListReportingDataAnnotationsRequest.Builder	clearPageToken()	Optional.
ListReportingDataAnnotationsRequest.Builder	clearParent()	Required.
ListReportingDataAnnotationsRequest	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getFilter()	Optional.
com.google.protobuf.ByteString	getFilterBytes()	Optional.
int	getPageSize()	Optional.
String	getPageToken()	Optional.
com.google.protobuf.ByteString	getPageTokenBytes()	Optional.
String	getParent()	Required.
com.google.protobuf.ByteString	getParentBytes()	Required.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
ListReportingDataAnnotationsRequest.Builder	mergeFrom(ListReportingDataAnnotationsRequest other)
ListReportingDataAnnotationsRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ListReportingDataAnnotationsRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ListReportingDataAnnotationsRequest.Builder	setFilter(String value)	Optional.
ListReportingDataAnnotationsRequest.Builder	setFilterBytes(com.google.protobuf.ByteString value)	Optional.
ListReportingDataAnnotationsRequest.Builder	setPageSize(int value)	Optional.
ListReportingDataAnnotationsRequest.Builder	setPageToken(String value)	Optional.
ListReportingDataAnnotationsRequest.Builder	setPageTokenBytes(com.google.protobuf.ByteString value)	Optional.
ListReportingDataAnnotationsRequest.Builder	setParent(String value)	Required.
ListReportingDataAnnotationsRequest.Builder	setParentBytes(com.google.protobuf.ByteString value)	Required.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

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<ListReportingDataAnnotationsRequest.Builder>

clear

public ListReportingDataAnnotationsRequest.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<ListReportingDataAnnotationsRequest.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<ListReportingDataAnnotationsRequest.Builder>

getDefaultInstanceForType

public ListReportingDataAnnotationsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ListReportingDataAnnotationsRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ListReportingDataAnnotationsRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public ListReportingDataAnnotationsRequest.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<ListReportingDataAnnotationsRequest.Builder>

mergeFrom

public ListReportingDataAnnotationsRequest.Builder mergeFrom(ListReportingDataAnnotationsRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListReportingDataAnnotationsRequest.Builder>

mergeFrom

public ListReportingDataAnnotationsRequest.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<ListReportingDataAnnotationsRequest.Builder>

Throws:

IOException

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.

setParent

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) = { ... }

Parameters:

value - The parent to set.

Returns:

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:

This builder for chaining.

setParentBytes

public ListReportingDataAnnotationsRequest.Builder setParentBytes(com.google.protobuf.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) = { ... }

Parameters:

value - The bytes for parent to set.

Returns:

This builder for chaining.

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.

setFilter

public ListReportingDataAnnotationsRequest.Builder setFilter(String value)

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

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

clearFilter

public ListReportingDataAnnotationsRequest.Builder clearFilter()

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

Returns:

This builder for chaining.

setFilterBytes

public ListReportingDataAnnotationsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)

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

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

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.

setPageSize

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

Parameters:

value - The pageSize to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

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.

setPageToken

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

Parameters:

value - The pageToken to set.

Returns:

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:

This builder for chaining.

setPageTokenBytes

public ListReportingDataAnnotationsRequest.Builder setPageTokenBytes(com.google.protobuf.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];

Parameters:

value - The bytes for pageToken to set.

Returns:

This builder for chaining.