RenderProductIssuesRequest.php

<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/shopping/merchant/issueresolution/v1/issueresolution.proto

namespace Google\Shopping\Merchant\IssueResolution\V1;

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

/**
 * Request to provide an issue resolution content and actions for product issues
 * of business's product.
 *
 * Generated from protobuf message <code>google.shopping.merchant.issueresolution.v1.RenderProductIssuesRequest</code>
 */
class RenderProductIssuesRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The name of the product to fetch issues for.
     * Format: `accounts/{account}/products/{product}`
     *
     * Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     */
    protected $name = '';
    /**
     * Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language
     * code used to localize an issue resolution content. If not set, the result
     * will be in default language `en-US`.
     *
     * Generated from protobuf field <code>string language_code = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $language_code = '';
    /**
     * Optional. The [IANA](https://www.iana.org/time-zones) timezone used to
     * localize times in an issue resolution content. For example
     * 'America/Los_Angeles'. If not set, results will use as a default UTC.
     *
     * Generated from protobuf field <code>string time_zone = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $time_zone = '';
    /**
     * Optional. The payload for configuring how the content should be rendered.
     *
     * Generated from protobuf field <code>.google.shopping.merchant.issueresolution.v1.RenderIssuesRequestPayload payload = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $payload = null;
    /**
     * Optional. If true, the `{product}` in the `name` field of the request will
     * be interpreted as unpadded base64url-encoded and decoded during request
     * processing to match the decoded value. Default value is `false`. Use this
     * if your `{product}` contains special characters, such as forward slash `/`
     * or other characters that are unpadded base64url-encoded (as per RFC 7515:
     * https://datatracker.ietf.org/doc/html/rfc7515#section-2).
     * Note that future versions of the API will only accept unpadded
     * base64url-encoded product ids, so we strongly recommend proactively setting
     * this to `true` and encoding the product ids.
     *
     * Generated from protobuf field <code>bool product_id_base64_url_encoded = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $product_id_base64_url_encoded = false;

    /**
     * @param string $name Required. The name of the product to fetch issues for.
     *                     Format: `accounts/{account}/products/{product}`
     *                     Please see {@see IssueResolutionServiceClient::productName()} for help formatting this field.
     *
     * @return \Google\Shopping\Merchant\IssueResolution\V1\RenderProductIssuesRequest
     *
     * @experimental
     */
    public static function build(string $name): self
    {
        return (new self())
            ->setName($name);
    }

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $name
     *           Required. The name of the product to fetch issues for.
     *           Format: `accounts/{account}/products/{product}`
     *     @type string $language_code
     *           Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language
     *           code used to localize an issue resolution content. If not set, the result
     *           will be in default language `en-US`.
     *     @type string $time_zone
     *           Optional. The [IANA](https://www.iana.org/time-zones) timezone used to
     *           localize times in an issue resolution content. For example
     *           'America/Los_Angeles'. If not set, results will use as a default UTC.
     *     @type \Google\Shopping\Merchant\IssueResolution\V1\RenderIssuesRequestPayload $payload
     *           Optional. The payload for configuring how the content should be rendered.
     *     @type bool $product_id_base64_url_encoded
     *           Optional. If true, the `{product}` in the `name` field of the request will
     *           be interpreted as unpadded base64url-encoded and decoded during request
     *           processing to match the decoded value. Default value is `false`. Use this
     *           if your `{product}` contains special characters, such as forward slash `/`
     *           or other characters that are unpadded base64url-encoded (as per RFC 7515:
     *           https://datatracker.ietf.org/doc/html/rfc7515#section-2).
     *           Note that future versions of the API will only accept unpadded
     *           base64url-encoded product ids, so we strongly recommend proactively setting
     *           this to `true` and encoding the product ids.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Shopping\Merchant\Issueresolution\V1\Issueresolution::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The name of the product to fetch issues for.
     * Format: `accounts/{account}/products/{product}`
     *
     * Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Required. The name of the product to fetch issues for.
     * Format: `accounts/{account}/products/{product}`
     *
     * Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     * @param string $var
     * @return $this
     */
    public function setName($var)
    {
        GPBUtil::checkString($var, True);
        $this->name = $var;

        return $this;
    }

    /**
     * Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language
     * code used to localize an issue resolution content. If not set, the result
     * will be in default language `en-US`.
     *
     * Generated from protobuf field <code>string language_code = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getLanguageCode()
    {
        return $this->language_code;
    }

    /**
     * Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language
     * code used to localize an issue resolution content. If not set, the result
     * will be in default language `en-US`.
     *
     * Generated from protobuf field <code>string language_code = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setLanguageCode($var)
    {
        GPBUtil::checkString($var, True);
        $this->language_code = $var;

        return $this;
    }

    /**
     * Optional. The [IANA](https://www.iana.org/time-zones) timezone used to
     * localize times in an issue resolution content. For example
     * 'America/Los_Angeles'. If not set, results will use as a default UTC.
     *
     * Generated from protobuf field <code>string time_zone = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getTimeZone()
    {
        return $this->time_zone;
    }

    /**
     * Optional. The [IANA](https://www.iana.org/time-zones) timezone used to
     * localize times in an issue resolution content. For example
     * 'America/Los_Angeles'. If not set, results will use as a default UTC.
     *
     * Generated from protobuf field <code>string time_zone = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setTimeZone($var)
    {
        GPBUtil::checkString($var, True);
        $this->time_zone = $var;

        return $this;
    }

    /**
     * Optional. The payload for configuring how the content should be rendered.
     *
     * Generated from protobuf field <code>.google.shopping.merchant.issueresolution.v1.RenderIssuesRequestPayload payload = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return \Google\Shopping\Merchant\IssueResolution\V1\RenderIssuesRequestPayload|null
     */
    public function getPayload()
    {
        return $this->payload;
    }

    public function hasPayload()
    {
        return isset($this->payload);
    }

    public function clearPayload()
    {
        unset($this->payload);
    }

    /**
     * Optional. The payload for configuring how the content should be rendered.
     *
     * Generated from protobuf field <code>.google.shopping.merchant.issueresolution.v1.RenderIssuesRequestPayload payload = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param \Google\Shopping\Merchant\IssueResolution\V1\RenderIssuesRequestPayload $var
     * @return $this
     */
    public function setPayload($var)
    {
        GPBUtil::checkMessage($var, \Google\Shopping\Merchant\IssueResolution\V1\RenderIssuesRequestPayload::class);
        $this->payload = $var;

        return $this;
    }

    /**
     * Optional. If true, the `{product}` in the `name` field of the request will
     * be interpreted as unpadded base64url-encoded and decoded during request
     * processing to match the decoded value. Default value is `false`. Use this
     * if your `{product}` contains special characters, such as forward slash `/`
     * or other characters that are unpadded base64url-encoded (as per RFC 7515:
     * https://datatracker.ietf.org/doc/html/rfc7515#section-2).
     * Note that future versions of the API will only accept unpadded
     * base64url-encoded product ids, so we strongly recommend proactively setting
     * this to `true` and encoding the product ids.
     *
     * Generated from protobuf field <code>bool product_id_base64_url_encoded = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return bool
     */
    public function getProductIdBase64UrlEncoded()
    {
        return $this->product_id_base64_url_encoded;
    }

    /**
     * Optional. If true, the `{product}` in the `name` field of the request will
     * be interpreted as unpadded base64url-encoded and decoded during request
     * processing to match the decoded value. Default value is `false`. Use this
     * if your `{product}` contains special characters, such as forward slash `/`
     * or other characters that are unpadded base64url-encoded (as per RFC 7515:
     * https://datatracker.ietf.org/doc/html/rfc7515#section-2).
     * Note that future versions of the API will only accept unpadded
     * base64url-encoded product ids, so we strongly recommend proactively setting
     * this to `true` and encoding the product ids.
     *
     * Generated from protobuf field <code>bool product_id_base64_url_encoded = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param bool $var
     * @return $this
     */
    public function setProductIdBase64UrlEncoded($var)
    {
        GPBUtil::checkBool($var);
        $this->product_id_base64_url_encoded = $var;

        return $this;
    }

}