// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/securitycenter/v1/securitycenter_service.proto

package com.google.cloud.securitycenter.v1;

public interface GroupAssetsRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.securitycenter.v1.GroupAssetsRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * <pre>
   * Name of the organization to groupBy. Its format is
   * "organizations/[organization_id]".
   * </pre>
   *
   * <code>string parent = 1;</code>
   */
  java.lang.String getParent();
  /**
   *
   *
   * <pre>
   * Name of the organization to groupBy. Its format is
   * "organizations/[organization_id]".
   * </pre>
   *
   * <code>string parent = 1;</code>
   */
  com.google.protobuf.ByteString getParentBytes();

  /**
   *
   *
   * <pre>
   * Expression that defines the filter to apply across assets.
   * The expression is a list of zero or more restrictions combined via logical
   * operators `AND` and `OR`.
   * Parentheses are supported, and `OR` has higher precedence than `AND`.
   * Restrictions have the form `&lt;field&gt; &lt;operator&gt; &lt;value&gt;` and may have a `-`
   * character in front of them to indicate negation. The fields map to those
   * defined in the Asset resource. Examples include:
   * * name
   * * security_center_properties.resource_name
   * * resource_properties.a_property
   * * security_marks.marks.marka
   * The supported operators are:
   * * `=` for all value types.
   * * `&gt;`, `&lt;`, `&gt;=`, `&lt;=` 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 | '='
   * update_time | '&gt;', '&lt;', '&gt;=', '&lt;=', '='
   * create_time | '&gt;', '&lt;', '&gt;=', '&lt;=', '='
   * iam_policy.policy_blob | '=', ':'
   * resource_properties | '=', ':', '&gt;', '&lt;', '&gt;=', '&lt;='
   * security_marks | '=', ':'
   * security_center_properties.resource_name | '=', ':'
   * security_center_properties.resource_type | '=', ':'
   * security_center_properties.resource_parent | '=', ':'
   * security_center_properties.resource_project | '=', ':'
   * security_center_properties.resource_owners | '=', ':'
   * For example, `resource_properties.size = 100` is a valid filter string.
   * </pre>
   *
   * <code>string filter = 2;</code>
   */
  java.lang.String getFilter();
  /**
   *
   *
   * <pre>
   * Expression that defines the filter to apply across assets.
   * The expression is a list of zero or more restrictions combined via logical
   * operators `AND` and `OR`.
   * Parentheses are supported, and `OR` has higher precedence than `AND`.
   * Restrictions have the form `&lt;field&gt; &lt;operator&gt; &lt;value&gt;` and may have a `-`
   * character in front of them to indicate negation. The fields map to those
   * defined in the Asset resource. Examples include:
   * * name
   * * security_center_properties.resource_name
   * * resource_properties.a_property
   * * security_marks.marks.marka
   * The supported operators are:
   * * `=` for all value types.
   * * `&gt;`, `&lt;`, `&gt;=`, `&lt;=` 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 | '='
   * update_time | '&gt;', '&lt;', '&gt;=', '&lt;=', '='
   * create_time | '&gt;', '&lt;', '&gt;=', '&lt;=', '='
   * iam_policy.policy_blob | '=', ':'
   * resource_properties | '=', ':', '&gt;', '&lt;', '&gt;=', '&lt;='
   * security_marks | '=', ':'
   * security_center_properties.resource_name | '=', ':'
   * security_center_properties.resource_type | '=', ':'
   * security_center_properties.resource_parent | '=', ':'
   * security_center_properties.resource_project | '=', ':'
   * security_center_properties.resource_owners | '=', ':'
   * For example, `resource_properties.size = 100` is a valid filter string.
   * </pre>
   *
   * <code>string filter = 2;</code>
   */
  com.google.protobuf.ByteString getFilterBytes();

  /**
   *
   *
   * <pre>
   * Expression that defines what assets fields to use for grouping. The string
   * value should follow SQL syntax: comma separated list of fields. For
   * example:
   * "security_center_properties.resource_project,security_center_properties.project".
   * The following fields are supported when compare_duration is not set:
   * * security_center_properties.resource_project
   * * security_center_properties.resource_type
   * * security_center_properties.resource_parent
   * The following fields are supported when compare_duration is set:
   * * security_center_properties.resource_type
   * </pre>
   *
   * <code>string group_by = 3;</code>
   */
  java.lang.String getGroupBy();
  /**
   *
   *
   * <pre>
   * Expression that defines what assets fields to use for grouping. The string
   * value should follow SQL syntax: comma separated list of fields. For
   * example:
   * "security_center_properties.resource_project,security_center_properties.project".
   * The following fields are supported when compare_duration is not set:
   * * security_center_properties.resource_project
   * * security_center_properties.resource_type
   * * security_center_properties.resource_parent
   * The following fields are supported when compare_duration is set:
   * * security_center_properties.resource_type
   * </pre>
   *
   * <code>string group_by = 3;</code>
   */
  com.google.protobuf.ByteString getGroupByBytes();

  /**
   *
   *
   * <pre>
   * When compare_duration is set, the GroupResult's "state_change" property is
   * updated to indicate whether the asset was added, removed, or remained
   * present 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 of the asset 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 asset is
   * removed and re-created again.
   * Possible "state_change" values when compare_duration is specified:
   * * "ADDED":   indicates that the asset was not present at the start of
   *                compare_duration, but present at reference_time.
   * * "REMOVED": indicates that the asset was present at the start of
   *                compare_duration, but not present at reference_time.
   * * "ACTIVE":  indicates that the asset was present at both the
   *                start and the end of the time period defined by
   *                compare_duration and reference_time.
   * If compare_duration is not specified, then the only possible state_change
   * is "UNUSED", which will be the state_change set for all assets present at
   * read_time.
   * If this field is set then `state_change` must be a specified field in
   * `group_by`.
   * </pre>
   *
   * <code>.google.protobuf.Duration compare_duration = 4;</code>
   */
  boolean hasCompareDuration();
  /**
   *
   *
   * <pre>
   * When compare_duration is set, the GroupResult's "state_change" property is
   * updated to indicate whether the asset was added, removed, or remained
   * present 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 of the asset 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 asset is
   * removed and re-created again.
   * Possible "state_change" values when compare_duration is specified:
   * * "ADDED":   indicates that the asset was not present at the start of
   *                compare_duration, but present at reference_time.
   * * "REMOVED": indicates that the asset was present at the start of
   *                compare_duration, but not present at reference_time.
   * * "ACTIVE":  indicates that the asset was present at both the
   *                start and the end of the time period defined by
   *                compare_duration and reference_time.
   * If compare_duration is not specified, then the only possible state_change
   * is "UNUSED", which will be the state_change set for all assets present at
   * read_time.
   * If this field is set then `state_change` must be a specified field in
   * `group_by`.
   * </pre>
   *
   * <code>.google.protobuf.Duration compare_duration = 4;</code>
   */
  com.google.protobuf.Duration getCompareDuration();
  /**
   *
   *
   * <pre>
   * When compare_duration is set, the GroupResult's "state_change" property is
   * updated to indicate whether the asset was added, removed, or remained
   * present 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 of the asset 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 asset is
   * removed and re-created again.
   * Possible "state_change" values when compare_duration is specified:
   * * "ADDED":   indicates that the asset was not present at the start of
   *                compare_duration, but present at reference_time.
   * * "REMOVED": indicates that the asset was present at the start of
   *                compare_duration, but not present at reference_time.
   * * "ACTIVE":  indicates that the asset was present at both the
   *                start and the end of the time period defined by
   *                compare_duration and reference_time.
   * If compare_duration is not specified, then the only possible state_change
   * is "UNUSED", which will be the state_change set for all assets present at
   * read_time.
   * If this field is set then `state_change` must be a specified field in
   * `group_by`.
   * </pre>
   *
   * <code>.google.protobuf.Duration compare_duration = 4;</code>
   */
  com.google.protobuf.DurationOrBuilder getCompareDurationOrBuilder();

  /**
   *
   *
   * <pre>
   * Time used as a reference point when filtering assets. The filter is limited
   * to assets 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.
   * </pre>
   *
   * <code>.google.protobuf.Timestamp read_time = 5;</code>
   */
  boolean hasReadTime();
  /**
   *
   *
   * <pre>
   * Time used as a reference point when filtering assets. The filter is limited
   * to assets 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.
   * </pre>
   *
   * <code>.google.protobuf.Timestamp read_time = 5;</code>
   */
  com.google.protobuf.Timestamp getReadTime();
  /**
   *
   *
   * <pre>
   * Time used as a reference point when filtering assets. The filter is limited
   * to assets 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.
   * </pre>
   *
   * <code>.google.protobuf.Timestamp read_time = 5;</code>
   */
  com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder();

  /**
   *
   *
   * <pre>
   * The value returned by the last `GroupAssetsResponse`; indicates
   * that this is a continuation of a prior `GroupAssets` call, and that the
   * system should return the next page of data.
   * </pre>
   *
   * <code>string page_token = 7;</code>
   */
  java.lang.String getPageToken();
  /**
   *
   *
   * <pre>
   * The value returned by the last `GroupAssetsResponse`; indicates
   * that this is a continuation of a prior `GroupAssets` call, and that the
   * system should return the next page of data.
   * </pre>
   *
   * <code>string page_token = 7;</code>
   */
  com.google.protobuf.ByteString getPageTokenBytes();

  /**
   *
   *
   * <pre>
   * The maximum number of results to return in a single response. Default is
   * 10, minimum is 1, maximum is 1000.
   * </pre>
   *
   * <code>int32 page_size = 8;</code>
   */
  int getPageSize();
}
