<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/analytics/admin/v1alpha/analytics_admin.proto

namespace Google\Analytics\Admin\V1alpha;

use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\RepeatedField;
use Google\Protobuf\Internal\GPBUtil;

/**
 * Request message for ListReportingDataAnnotation RPC.
 *
 * Generated from protobuf message <code>google.analytics.admin.v1alpha.ListReportingDataAnnotationsRequest</code>
 */
class ListReportingDataAnnotationsRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. Resource name of the property.
     * Format: properties/property_id
     * Example: properties/123
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     */
    protected $parent = '';
    /**
     * 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`
     *
     * Generated from protobuf field <code>string filter = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $filter = '';
    /**
     * 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)
     *
     * Generated from protobuf field <code>int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $page_size = 0;
    /**
     * 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.
     *
     * Generated from protobuf field <code>string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $page_token = '';

    /**
     * @param string $parent Required. Resource name of the property.
     *                       Format: properties/property_id
     *                       Example: properties/123
     *                       Please see {@see AnalyticsAdminServiceClient::propertyName()} for help formatting this field.
     *
     * @return \Google\Analytics\Admin\V1alpha\ListReportingDataAnnotationsRequest
     *
     * @experimental
     */
    public static function build(string $parent): self
    {
        return (new self())
            ->setParent($parent);
    }

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $parent
     *           Required. Resource name of the property.
     *           Format: properties/property_id
     *           Example: properties/123
     *     @type string $filter
     *           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`
     *     @type int $page_size
     *           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)
     *     @type string $page_token
     *           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.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Analytics\Admin\V1Alpha\AnalyticsAdmin::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. Resource name of the property.
     * Format: properties/property_id
     * Example: properties/123
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     * @return string
     */
    public function getParent()
    {
        return $this->parent;
    }

    /**
     * Required. Resource name of the property.
     * Format: properties/property_id
     * Example: properties/123
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     * @param string $var
     * @return $this
     */
    public function setParent($var)
    {
        GPBUtil::checkString($var, True);
        $this->parent = $var;

        return $this;
    }

    /**
     * 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`
     *
     * Generated from protobuf field <code>string filter = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * 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`
     *
     * Generated from protobuf field <code>string filter = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setFilter($var)
    {
        GPBUtil::checkString($var, True);
        $this->filter = $var;

        return $this;
    }

    /**
     * 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)
     *
     * Generated from protobuf field <code>int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return int
     */
    public function getPageSize()
    {
        return $this->page_size;
    }

    /**
     * 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)
     *
     * Generated from protobuf field <code>int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param int $var
     * @return $this
     */
    public function setPageSize($var)
    {
        GPBUtil::checkInt32($var);
        $this->page_size = $var;

        return $this;
    }

    /**
     * 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.
     *
     * Generated from protobuf field <code>string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getPageToken()
    {
        return $this->page_token;
    }

    /**
     * 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.
     *
     * Generated from protobuf field <code>string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setPageToken($var)
    {
        GPBUtil::checkString($var, True);
        $this->page_token = $var;

        return $this;
    }

}

