<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/cloud/securitycenter/v2/securitycenter_service.proto

namespace Google\Cloud\SecurityCenter\V2;

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

/**
 * Request message for listing the valued resources for a given simulation.
 *
 * Generated from protobuf message <code>google.cloud.securitycenter.v2.ListValuedResourcesRequest</code>
 */
class ListValuedResourcesRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. Name of parent to list exposed resources.
     * Valid formats:
     * "organizations/{organization}",
     * "organizations/{organization}/simulations/{simulation}"
     * "organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}"
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     */
    protected $parent = '';
    /**
     * The filter expression that filters the valued resources in the response.
     * Supported fields:
     *   * `resource_value` supports =
     *   * `resource_type` supports =
     *
     * Generated from protobuf field <code>string filter = 2;</code>
     */
    protected $filter = '';
    /**
     * The value returned by the last `ListValuedResourcesResponse`; indicates
     * that this is a continuation of a prior `ListValuedResources` call, and
     * that the system should return the next page of data.
     *
     * Generated from protobuf field <code>string page_token = 3;</code>
     */
    protected $page_token = '';
    /**
     * The maximum number of results to return in a single response. Default is
     * 10, minimum is 1, maximum is 1000.
     *
     * Generated from protobuf field <code>int32 page_size = 4;</code>
     */
    protected $page_size = 0;
    /**
     * Optional. The fields by which to order the valued resources response.
     * Supported fields:
     *   * `exposed_score`
     *   * `resource_value`
     *   * `resource_type`
     * Values should be a comma separated list of fields. For example:
     * `exposed_score,resource_value`.
     * The default sorting order is descending. To specify ascending or descending
     * order for a field, append a " ASC" or a " DESC" suffix, respectively; for
     * example: `exposed_score DESC`.
     *
     * Generated from protobuf field <code>string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $order_by = '';

    /**
     * @param string $parent Required. Name of parent to list exposed resources.
     *
     *                       Valid formats:
     *                       "organizations/{organization}",
     *                       "organizations/{organization}/simulations/{simulation}"
     *                       "organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}"
     *                       Please see {@see SecurityCenterClient::simulationName()} for help formatting this field.
     *
     * @return \Google\Cloud\SecurityCenter\V2\ListValuedResourcesRequest
     *
     * @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. Name of parent to list exposed resources.
     *           Valid formats:
     *           "organizations/{organization}",
     *           "organizations/{organization}/simulations/{simulation}"
     *           "organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}"
     *     @type string $filter
     *           The filter expression that filters the valued resources in the response.
     *           Supported fields:
     *             * `resource_value` supports =
     *             * `resource_type` supports =
     *     @type string $page_token
     *           The value returned by the last `ListValuedResourcesResponse`; indicates
     *           that this is a continuation of a prior `ListValuedResources` call, and
     *           that the system should return the next page of data.
     *     @type int $page_size
     *           The maximum number of results to return in a single response. Default is
     *           10, minimum is 1, maximum is 1000.
     *     @type string $order_by
     *           Optional. The fields by which to order the valued resources response.
     *           Supported fields:
     *             * `exposed_score`
     *             * `resource_value`
     *             * `resource_type`
     *           Values should be a comma separated list of fields. For example:
     *           `exposed_score,resource_value`.
     *           The default sorting order is descending. To specify ascending or descending
     *           order for a field, append a " ASC" or a " DESC" suffix, respectively; for
     *           example: `exposed_score DESC`.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Securitycenter\V2\SecuritycenterService::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. Name of parent to list exposed resources.
     * Valid formats:
     * "organizations/{organization}",
     * "organizations/{organization}/simulations/{simulation}"
     * "organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}"
     *
     * 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. Name of parent to list exposed resources.
     * Valid formats:
     * "organizations/{organization}",
     * "organizations/{organization}/simulations/{simulation}"
     * "organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}"
     *
     * 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;
    }

    /**
     * The filter expression that filters the valued resources in the response.
     * Supported fields:
     *   * `resource_value` supports =
     *   * `resource_type` supports =
     *
     * Generated from protobuf field <code>string filter = 2;</code>
     * @return string
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * The filter expression that filters the valued resources in the response.
     * Supported fields:
     *   * `resource_value` supports =
     *   * `resource_type` supports =
     *
     * Generated from protobuf field <code>string filter = 2;</code>
     * @param string $var
     * @return $this
     */
    public function setFilter($var)
    {
        GPBUtil::checkString($var, True);
        $this->filter = $var;

        return $this;
    }

    /**
     * The value returned by the last `ListValuedResourcesResponse`; indicates
     * that this is a continuation of a prior `ListValuedResources` call, and
     * that the system should return the next page of data.
     *
     * Generated from protobuf field <code>string page_token = 3;</code>
     * @return string
     */
    public function getPageToken()
    {
        return $this->page_token;
    }

    /**
     * The value returned by the last `ListValuedResourcesResponse`; indicates
     * that this is a continuation of a prior `ListValuedResources` call, and
     * that the system should return the next page of data.
     *
     * Generated from protobuf field <code>string page_token = 3;</code>
     * @param string $var
     * @return $this
     */
    public function setPageToken($var)
    {
        GPBUtil::checkString($var, True);
        $this->page_token = $var;

        return $this;
    }

    /**
     * The maximum number of results to return in a single response. Default is
     * 10, minimum is 1, maximum is 1000.
     *
     * Generated from protobuf field <code>int32 page_size = 4;</code>
     * @return int
     */
    public function getPageSize()
    {
        return $this->page_size;
    }

    /**
     * The maximum number of results to return in a single response. Default is
     * 10, minimum is 1, maximum is 1000.
     *
     * Generated from protobuf field <code>int32 page_size = 4;</code>
     * @param int $var
     * @return $this
     */
    public function setPageSize($var)
    {
        GPBUtil::checkInt32($var);
        $this->page_size = $var;

        return $this;
    }

    /**
     * Optional. The fields by which to order the valued resources response.
     * Supported fields:
     *   * `exposed_score`
     *   * `resource_value`
     *   * `resource_type`
     * Values should be a comma separated list of fields. For example:
     * `exposed_score,resource_value`.
     * The default sorting order is descending. To specify ascending or descending
     * order for a field, append a " ASC" or a " DESC" suffix, respectively; for
     * example: `exposed_score DESC`.
     *
     * Generated from protobuf field <code>string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getOrderBy()
    {
        return $this->order_by;
    }

    /**
     * Optional. The fields by which to order the valued resources response.
     * Supported fields:
     *   * `exposed_score`
     *   * `resource_value`
     *   * `resource_type`
     * Values should be a comma separated list of fields. For example:
     * `exposed_score,resource_value`.
     * The default sorting order is descending. To specify ascending or descending
     * order for a field, append a " ASC" or a " DESC" suffix, respectively; for
     * example: `exposed_score DESC`.
     *
     * Generated from protobuf field <code>string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setOrderBy($var)
    {
        GPBUtil::checkString($var, True);
        $this->order_by = $var;

        return $this;
    }

}

