• Home
• com.google.api.grpc
• proto-google-cloud-securitycenter-v1beta1
• 0.157.0
• source code
• GroupAssetsRequestOrBuilder.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.cloud.securitycenter.v1beta1.GroupAssetsRequestOrBuilder Maven / Gradle / Ivy

/*
 * Copyright 2024 Google LLC
 *
 * 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
 *
 *     https://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.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/securitycenter/v1beta1/securitycenter_service.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.securitycenter.v1beta1;

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

  /**
   *
   *
   * 
   * Required. Name of the organization to groupBy. Its format is
   * "organizations/[organization_id]".
   * 
   *
   * 
   * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The parent.
   */
  java.lang.String getParent();
  /**
   *
   *
   * 
   * Required. Name of the organization to groupBy. Its format is
   * "organizations/[organization_id]".
   * 
   *
   * 
   * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for parent.
   */
  com.google.protobuf.ByteString getParentBytes();

  /**
   *
   *
   * 
   * 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 not supported, and `OR` has higher precedence than `AND`.
   *
   * Restrictions have the form `<field> <operator> <value>` 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.
   * * `>`, `<`, `>=`, `<=` 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.
   *
   * For example, `resource_properties.size = 100` is a valid filter string.
   * 
   *
   * string filter = 2;
   *
   * @return The filter.
   */
  java.lang.String getFilter();
  /**
   *
   *
   * 
   * 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 not supported, and `OR` has higher precedence than `AND`.
   *
   * Restrictions have the form `<field> <operator> <value>` 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.
   * * `>`, `<`, `>=`, `<=` 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.
   *
   * For example, `resource_properties.size = 100` is a valid filter string.
   * 
   *
   * string filter = 2;
   *
   * @return The bytes for filter.
   */
  com.google.protobuf.ByteString getFilterBytes();

  /**
   *
   *
   * 
   * Required. 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
   * 
   *
   * string group_by = 3 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The groupBy.
   */
  java.lang.String getGroupBy();
  /**
   *
   *
   * 
   * Required. 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
   * 
   *
   * string group_by = 3 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for groupBy.
   */
  com.google.protobuf.ByteString getGroupByBytes();

  /**
   *
   *
   * 
   * When compare_duration is set, the Asset's "state" 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 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" values when compare_duration is specified:
   *
   * * "ADDED": indicates that the asset was not present before
   *              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.
   *
   * This field is ignored if `state` is not a field in `group_by`.
   * 
   *
   * .google.protobuf.Duration compare_duration = 4;
   *
   * @return Whether the compareDuration field is set.
   */
  boolean hasCompareDuration();
  /**
   *
   *
   * 
   * When compare_duration is set, the Asset's "state" 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 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" values when compare_duration is specified:
   *
   * * "ADDED": indicates that the asset was not present before
   *              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.
   *
   * This field is ignored if `state` is not a field in `group_by`.
   * 
   *
   * .google.protobuf.Duration compare_duration = 4;
   *
   * @return The compareDuration.
   */
  com.google.protobuf.Duration getCompareDuration();
  /**
   *
   *
   * 
   * When compare_duration is set, the Asset's "state" 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 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" values when compare_duration is specified:
   *
   * * "ADDED": indicates that the asset was not present before
   *              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.
   *
   * This field is ignored if `state` is not a field in `group_by`.
   * 
   *
   * .google.protobuf.Duration compare_duration = 4;
   */
  com.google.protobuf.DurationOrBuilder getCompareDurationOrBuilder();

  /**
   *
   *
   * 
   * 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.
   * 
   *
   * .google.protobuf.Timestamp read_time = 5;
   *
   * @return Whether the readTime field is set.
   */
  boolean hasReadTime();
  /**
   *
   *
   * 
   * 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.
   * 
   *
   * .google.protobuf.Timestamp read_time = 5;
   *
   * @return The readTime.
   */
  com.google.protobuf.Timestamp getReadTime();
  /**
   *
   *
   * 
   * 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.
   * 
   *
   * .google.protobuf.Timestamp read_time = 5;
   */
  com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder();

  /**
   *
   *
   * 
   * 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.
   * 
   *
   * string page_token = 7;
   *
   * @return The pageToken.
   */
  java.lang.String getPageToken();
  /**
   *
   *
   * 
   * 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.
   * 
   *
   * string page_token = 7;
   *
   * @return The bytes for pageToken.
   */
  com.google.protobuf.ByteString getPageTokenBytes();

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