<?php
/*
 * Copyright 2014 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

namespace Google\Service\SecurityCommandCenter;

class GroupFindingsRequest extends \Google\Model
{
  /**
   * When compare_duration is set, the GroupResult's "state_change" attribute is
   * updated to indicate whether the finding had its state changed, the
   * finding's state remained unchanged, or if the finding was added during the
   * compare_duration period of time that precedes the read_time. This is the
   * time between (read_time - compare_duration) and read_time. The state_change
   * value is derived based on the presence and state of the finding at the two
   * points in time. Intermediate state changes between the two times don't
   * affect the result. For example, the results aren't affected if the finding
   * is made inactive and then active again. Possible "state_change" values when
   * compare_duration is specified: * "CHANGED": indicates that the finding was
   * present and matched the given filter at the start of compare_duration, but
   * changed its state at read_time. * "UNCHANGED": indicates that the finding
   * was present and matched the given filter at the start of compare_duration
   * and did not change state at read_time. * "ADDED": indicates that the
   * finding did not match the given filter or was not present at the start of
   * compare_duration, but was present at read_time. * "REMOVED": indicates that
   * the finding was present and matched the filter at the start of
   * compare_duration, but did not match the filter at read_time. If
   * compare_duration is not specified, then the only possible state_change is
   * "UNUSED", which will be the state_change set for all findings present at
   * read_time. If this field is set then `state_change` must be a specified
   * field in `group_by`.
   *
   * @deprecated
   * @var string
   */
  public $compareDuration;
  /**
   * Expression that defines the filter to apply across findings. The expression
   * is a list of one or more restrictions combined via logical operators `AND`
   * and `OR`. Parentheses are supported, and `OR` has higher precedence than
   * `AND`. Restrictions have the form ` ` and may have a `-` character in front
   * of them to indicate negation. Examples include: * name *
   * source_properties.a_property * security_marks.marks.marka The supported
   * operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for
   * integer values. * `:`, meaning substring matching, for strings. The
   * supported value types are: * string literals in quotes. * integer literals
   * without quotes. * boolean literals `true` and `false` without quotes. The
   * following field and operator combinations are supported: * name: `=` *
   * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category:
   * `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `<`, `>=`, `<=`
   * Usage: This should be milliseconds since epoch or an RFC3339 string.
   * Examples: `event_time = "2019-06-10T16:07:18-07:00"` `event_time =
   * 1560208038000` * severity: `=`, `:` * workflow_state: `=`, `:` *
   * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, `>`, `<`,
   * `>=`, `<=` For example, `source_properties.size = 100` is a valid filter
   * string. Use a partial match on the empty string to filter based on a
   * property existing: `source_properties.my_property : ""` Use a negated
   * partial match on the empty string to filter based on a property not
   * existing: `-source_properties.my_property : ""` * resource: *
   * resource.name: `=`, `:` * resource.parent_name: `=`, `:` *
   * resource.parent_display_name: `=`, `:` * resource.project_name: `=`, `:` *
   * resource.project_display_name: `=`, `:` * resource.type: `=`, `:`
   *
   * @var string
   */
  public $filter;
  /**
   * Required. Expression that defines what assets fields to use for grouping
   * (including `state_change`). The string value should follow SQL syntax:
   * comma separated list of fields. For example: "parent,resource_name". The
   * following fields are supported when compare_duration is set: * state_change
   *
   * @var string
   */
  public $groupBy;
  /**
   * The maximum number of results to return in a single response. Default is
   * 10, minimum is 1, maximum is 1000.
   *
   * @var int
   */
  public $pageSize;
  /**
   * The value returned by the last `GroupFindingsResponse`; indicates that this
   * is a continuation of a prior `GroupFindings` call, and that the system
   * should return the next page of data.
   *
   * @var string
   */
  public $pageToken;
  /**
   * Time used as a reference point when filtering findings. The filter is
   * limited to findings existing at the supplied time and their values are
   * those at that specific time. Absence of this field will default to the
   * API's version of NOW.
   *
   * @deprecated
   * @var string
   */
  public $readTime;

  /**
   * When compare_duration is set, the GroupResult's "state_change" attribute is
   * updated to indicate whether the finding had its state changed, the
   * finding's state remained unchanged, or if the finding was added during the
   * compare_duration period of time that precedes the read_time. This is the
   * time between (read_time - compare_duration) and read_time. The state_change
   * value is derived based on the presence and state of the finding at the two
   * points in time. Intermediate state changes between the two times don't
   * affect the result. For example, the results aren't affected if the finding
   * is made inactive and then active again. Possible "state_change" values when
   * compare_duration is specified: * "CHANGED": indicates that the finding was
   * present and matched the given filter at the start of compare_duration, but
   * changed its state at read_time. * "UNCHANGED": indicates that the finding
   * was present and matched the given filter at the start of compare_duration
   * and did not change state at read_time. * "ADDED": indicates that the
   * finding did not match the given filter or was not present at the start of
   * compare_duration, but was present at read_time. * "REMOVED": indicates that
   * the finding was present and matched the filter at the start of
   * compare_duration, but did not match the filter at read_time. If
   * compare_duration is not specified, then the only possible state_change is
   * "UNUSED", which will be the state_change set for all findings present at
   * read_time. If this field is set then `state_change` must be a specified
   * field in `group_by`.
   *
   * @deprecated
   * @param string $compareDuration
   */
  public function setCompareDuration($compareDuration)
  {
    $this->compareDuration = $compareDuration;
  }
  /**
   * @deprecated
   * @return string
   */
  public function getCompareDuration()
  {
    return $this->compareDuration;
  }
  /**
   * Expression that defines the filter to apply across findings. The expression
   * is a list of one or more restrictions combined via logical operators `AND`
   * and `OR`. Parentheses are supported, and `OR` has higher precedence than
   * `AND`. Restrictions have the form ` ` and may have a `-` character in front
   * of them to indicate negation. Examples include: * name *
   * source_properties.a_property * security_marks.marks.marka The supported
   * operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for
   * integer values. * `:`, meaning substring matching, for strings. The
   * supported value types are: * string literals in quotes. * integer literals
   * without quotes. * boolean literals `true` and `false` without quotes. The
   * following field and operator combinations are supported: * name: `=` *
   * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category:
   * `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `<`, `>=`, `<=`
   * Usage: This should be milliseconds since epoch or an RFC3339 string.
   * Examples: `event_time = "2019-06-10T16:07:18-07:00"` `event_time =
   * 1560208038000` * severity: `=`, `:` * workflow_state: `=`, `:` *
   * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, `>`, `<`,
   * `>=`, `<=` For example, `source_properties.size = 100` is a valid filter
   * string. Use a partial match on the empty string to filter based on a
   * property existing: `source_properties.my_property : ""` Use a negated
   * partial match on the empty string to filter based on a property not
   * existing: `-source_properties.my_property : ""` * resource: *
   * resource.name: `=`, `:` * resource.parent_name: `=`, `:` *
   * resource.parent_display_name: `=`, `:` * resource.project_name: `=`, `:` *
   * resource.project_display_name: `=`, `:` * resource.type: `=`, `:`
   *
   * @param string $filter
   */
  public function setFilter($filter)
  {
    $this->filter = $filter;
  }
  /**
   * @return string
   */
  public function getFilter()
  {
    return $this->filter;
  }
  /**
   * Required. Expression that defines what assets fields to use for grouping
   * (including `state_change`). The string value should follow SQL syntax:
   * comma separated list of fields. For example: "parent,resource_name". The
   * following fields are supported when compare_duration is set: * state_change
   *
   * @param string $groupBy
   */
  public function setGroupBy($groupBy)
  {
    $this->groupBy = $groupBy;
  }
  /**
   * @return string
   */
  public function getGroupBy()
  {
    return $this->groupBy;
  }
  /**
   * The maximum number of results to return in a single response. Default is
   * 10, minimum is 1, maximum is 1000.
   *
   * @param int $pageSize
   */
  public function setPageSize($pageSize)
  {
    $this->pageSize = $pageSize;
  }
  /**
   * @return int
   */
  public function getPageSize()
  {
    return $this->pageSize;
  }
  /**
   * The value returned by the last `GroupFindingsResponse`; indicates that this
   * is a continuation of a prior `GroupFindings` call, and that the system
   * should return the next page of data.
   *
   * @param string $pageToken
   */
  public function setPageToken($pageToken)
  {
    $this->pageToken = $pageToken;
  }
  /**
   * @return string
   */
  public function getPageToken()
  {
    return $this->pageToken;
  }
  /**
   * Time used as a reference point when filtering findings. The filter is
   * limited to findings existing at the supplied time and their values are
   * those at that specific time. Absence of this field will default to the
   * API's version of NOW.
   *
   * @deprecated
   * @param string $readTime
   */
  public function setReadTime($readTime)
  {
    $this->readTime = $readTime;
  }
  /**
   * @deprecated
   * @return string
   */
  public function getReadTime()
  {
    return $this->readTime;
  }
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GroupFindingsRequest::class, 'Google_Service_SecurityCommandCenter_GroupFindingsRequest');