google.analytics.admin.v1alpha.ListPropertiesRequest */ class ListPropertiesRequest extends \Google\Protobuf\Internal\Message { /** * Required. An expression for filtering the results of the request. * Fields eligible for filtering are: * `parent:`(The resource name of the parent account/property) or * `ancestor:`(The resource name of the parent account) or * `firebase_project:`(The id or number of the linked firebase project). * Some examples of filters: * ``` * | Filter | Description | * |-----------------------------|-------------------------------------------| * | parent:accounts/123 | The account with account id: 123. | * | parent:properties/123 | The property with property id: 123. | * | ancestor:accounts/123 | The account with account id: 123. | * | firebase_project:project-id | The firebase project with id: project-id. | * | firebase_project:123 | The firebase project with number: 123. | * ``` * * Generated from protobuf field string filter = 1 [(.google.api.field_behavior) = REQUIRED]; */ private $filter = ''; /** * 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 int32 page_size = 2; */ private $page_size = 0; /** * A page token, received from a previous `ListProperties` call. * Provide this to retrieve the subsequent page. * When paginating, all other parameters provided to `ListProperties` must * match the call that provided the page token. * * Generated from protobuf field string page_token = 3; */ private $page_token = ''; /** * Whether to include soft-deleted (ie: "trashed") Properties in the * results. Properties can be inspected to determine whether they are deleted * or not. * * Generated from protobuf field bool show_deleted = 4; */ private $show_deleted = false; /** * Constructor. * * @param array $data { * Optional. Data for populating the Message object. * * @type string $filter * Required. An expression for filtering the results of the request. * Fields eligible for filtering are: * `parent:`(The resource name of the parent account/property) or * `ancestor:`(The resource name of the parent account) or * `firebase_project:`(The id or number of the linked firebase project). * Some examples of filters: * ``` * | Filter | Description | * |-----------------------------|-------------------------------------------| * | parent:accounts/123 | The account with account id: 123. | * | parent:properties/123 | The property with property id: 123. | * | ancestor:accounts/123 | The account with account id: 123. | * | firebase_project:project-id | The firebase project with id: project-id. | * | firebase_project:123 | The firebase project with number: 123. | * ``` * @type int $page_size * 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 * A page token, received from a previous `ListProperties` call. * Provide this to retrieve the subsequent page. * When paginating, all other parameters provided to `ListProperties` must * match the call that provided the page token. * @type bool $show_deleted * Whether to include soft-deleted (ie: "trashed") Properties in the * results. Properties can be inspected to determine whether they are deleted * or not. * } */ public function __construct($data = NULL) { \GPBMetadata\Google\Analytics\Admin\V1Alpha\AnalyticsAdmin::initOnce(); parent::__construct($data); } /** * Required. An expression for filtering the results of the request. * Fields eligible for filtering are: * `parent:`(The resource name of the parent account/property) or * `ancestor:`(The resource name of the parent account) or * `firebase_project:`(The id or number of the linked firebase project). * Some examples of filters: * ``` * | Filter | Description | * |-----------------------------|-------------------------------------------| * | parent:accounts/123 | The account with account id: 123. | * | parent:properties/123 | The property with property id: 123. | * | ancestor:accounts/123 | The account with account id: 123. | * | firebase_project:project-id | The firebase project with id: project-id. | * | firebase_project:123 | The firebase project with number: 123. | * ``` * * Generated from protobuf field string filter = 1 [(.google.api.field_behavior) = REQUIRED]; * @return string */ public function getFilter() { return $this->filter; } /** * Required. An expression for filtering the results of the request. * Fields eligible for filtering are: * `parent:`(The resource name of the parent account/property) or * `ancestor:`(The resource name of the parent account) or * `firebase_project:`(The id or number of the linked firebase project). * Some examples of filters: * ``` * | Filter | Description | * |-----------------------------|-------------------------------------------| * | parent:accounts/123 | The account with account id: 123. | * | parent:properties/123 | The property with property id: 123. | * | ancestor:accounts/123 | The account with account id: 123. | * | firebase_project:project-id | The firebase project with id: project-id. | * | firebase_project:123 | The firebase project with number: 123. | * ``` * * Generated from protobuf field string filter = 1 [(.google.api.field_behavior) = REQUIRED]; * @param string $var * @return $this */ public function setFilter($var) { GPBUtil::checkString($var, True); $this->filter = $var; return $this; } /** * 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 int32 page_size = 2; * @return int */ public function getPageSize() { return $this->page_size; } /** * 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 int32 page_size = 2; * @param int $var * @return $this */ public function setPageSize($var) { GPBUtil::checkInt32($var); $this->page_size = $var; return $this; } /** * A page token, received from a previous `ListProperties` call. * Provide this to retrieve the subsequent page. * When paginating, all other parameters provided to `ListProperties` must * match the call that provided the page token. * * Generated from protobuf field string page_token = 3; * @return string */ public function getPageToken() { return $this->page_token; } /** * A page token, received from a previous `ListProperties` call. * Provide this to retrieve the subsequent page. * When paginating, all other parameters provided to `ListProperties` must * match the call that provided the page token. * * Generated from protobuf field string page_token = 3; * @param string $var * @return $this */ public function setPageToken($var) { GPBUtil::checkString($var, True); $this->page_token = $var; return $this; } /** * Whether to include soft-deleted (ie: "trashed") Properties in the * results. Properties can be inspected to determine whether they are deleted * or not. * * Generated from protobuf field bool show_deleted = 4; * @return bool */ public function getShowDeleted() { return $this->show_deleted; } /** * Whether to include soft-deleted (ie: "trashed") Properties in the * results. Properties can be inspected to determine whether they are deleted * or not. * * Generated from protobuf field bool show_deleted = 4; * @param bool $var * @return $this */ public function setShowDeleted($var) { GPBUtil::checkBool($var); $this->show_deleted = $var; return $this; } }