<?php
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v24/services/conversion_upload_service.proto

namespace Google\Ads\GoogleAds\V24\Services;

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

/**
 * Request message for
 * [ConversionUploadService.UploadClickConversions][google.ads.googleads.v24.services.ConversionUploadService.UploadClickConversions].
 *
 * Generated from protobuf message <code>google.ads.googleads.v24.services.UploadClickConversionsRequest</code>
 */
class UploadClickConversionsRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The ID of the customer performing the upload.
     *
     * Generated from protobuf field <code>string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];</code>
     */
    protected $customer_id = '';
    /**
     * Required. The conversions that are being uploaded.
     *
     * Generated from protobuf field <code>repeated .google.ads.googleads.v24.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];</code>
     */
    private $conversions;
    /**
     * Required. If `true`, successful operations will be carried out and invalid
     * operations will return errors. If `false`, all operations will be carried
     * out in one transaction if and only if they are all valid.
     * This should always be set to `true`.
     * See
     * [Best practices for partial
     * failures](/google-ads/api/docs/best-practices/partial-failures).
     *
     * Generated from protobuf field <code>bool partial_failure = 3 [(.google.api.field_behavior) = REQUIRED];</code>
     */
    protected $partial_failure = false;
    /**
     * If `true`, the request is validated but not executed. Only errors are
     * returned, not results.
     *
     * Generated from protobuf field <code>bool validate_only = 4;</code>
     */
    protected $validate_only = false;
    /**
     * Optional. Optional input to set job ID. Must be a non-negative number that
     * is less than 2^31 if provided. If this field is not provided, the API will
     * generate a job ID in the range [2^31, (2^63)-1]. The API will return the
     * value for this request in the `job_id` field of the
     * `UploadClickConversionsResponse`.
     *
     * Generated from protobuf field <code>optional int32 job_id = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $job_id = null;

    /**
     * @param string                                               $customerId     Required. The ID of the customer performing the upload.
     * @param \Google\Ads\GoogleAds\V24\Services\ClickConversion[] $conversions    Required. The conversions that are being uploaded.
     * @param bool                                                 $partialFailure Required. If `true`, successful operations will be carried out and invalid
     *                                                                             operations will return errors. If `false`, all operations will be carried
     *                                                                             out in one transaction if and only if they are all valid.
     *                                                                             This should always be set to `true`.
     *
     *                                                                             See
     *                                                                             [Best practices for partial
     *                                                                             failures](/google-ads/api/docs/best-practices/partial-failures).
     *
     * @return \Google\Ads\GoogleAds\V24\Services\UploadClickConversionsRequest
     *
     * @experimental
     */
    public static function build(string $customerId, array $conversions, bool $partialFailure): self
    {
        return (new self())
            ->setCustomerId($customerId)
            ->setConversions($conversions)
            ->setPartialFailure($partialFailure);
    }

    /**
     * Constructor.
     *
     * @param array $data {
     *                    Optional. Data for populating the Message object.
     *
     * @type string $customer_id
     *           Required. The ID of the customer performing the upload.
     * @type \Google\Ads\GoogleAds\V24\Services\ClickConversion[] $conversions
     *           Required. The conversions that are being uploaded.
     * @type bool $partial_failure
     *           Required. If `true`, successful operations will be carried out and invalid
     *           operations will return errors. If `false`, all operations will be carried
     *           out in one transaction if and only if they are all valid.
     *           This should always be set to `true`.
     *           See
     *           [Best practices for partial
     *           failures](/google-ads/api/docs/best-practices/partial-failures).
     * @type bool $validate_only
     *           If `true`, the request is validated but not executed. Only errors are
     *           returned, not results.
     * @type int $job_id
     *           Optional. Optional input to set job ID. Must be a non-negative number that
     *           is less than 2^31 if provided. If this field is not provided, the API will
     *           generate a job ID in the range [2^31, (2^63)-1]. The API will return the
     *           value for this request in the `job_id` field of the
     *           `UploadClickConversionsResponse`.
     * }
     */
    public function __construct($data = null)
    {
        \GPBMetadata\Google\Ads\GoogleAds\V24\Services\ConversionUploadService::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The ID of the customer performing the upload.
     *
     * Generated from protobuf field <code>string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];</code>
     *
     * @return string
     */
    public function getCustomerId()
    {
        return $this->customer_id;
    }

    /**
     * Required. The ID of the customer performing the upload.
     *
     * Generated from protobuf field <code>string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];</code>
     *
     * @param  string $var
     * @return $this
     */
    public function setCustomerId($var)
    {
        GPBUtil::checkString($var, true);
        $this->customer_id = $var;

        return $this;
    }

    /**
     * Required. The conversions that are being uploaded.
     *
     * Generated from protobuf field <code>repeated .google.ads.googleads.v24.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];</code>
     *
     * @return RepeatedField<\Google\Ads\GoogleAds\V24\Services\ClickConversion>
     */
    public function getConversions()
    {
        return $this->conversions;
    }

    /**
     * Required. The conversions that are being uploaded.
     *
     * Generated from protobuf field <code>repeated .google.ads.googleads.v24.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];</code>
     *
     * @param  \Google\Ads\GoogleAds\V24\Services\ClickConversion[] $var
     * @return $this
     */
    public function setConversions($var)
    {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\GoogleAds\V24\Services\ClickConversion::class);
        $this->conversions = $arr;

        return $this;
    }

    /**
     * Required. If `true`, successful operations will be carried out and invalid
     * operations will return errors. If `false`, all operations will be carried
     * out in one transaction if and only if they are all valid.
     * This should always be set to `true`.
     * See
     * [Best practices for partial
     * failures](/google-ads/api/docs/best-practices/partial-failures).
     *
     * Generated from protobuf field <code>bool partial_failure = 3 [(.google.api.field_behavior) = REQUIRED];</code>
     *
     * @return bool
     */
    public function getPartialFailure()
    {
        return $this->partial_failure;
    }

    /**
     * Required. If `true`, successful operations will be carried out and invalid
     * operations will return errors. If `false`, all operations will be carried
     * out in one transaction if and only if they are all valid.
     * This should always be set to `true`.
     * See
     * [Best practices for partial
     * failures](/google-ads/api/docs/best-practices/partial-failures).
     *
     * Generated from protobuf field <code>bool partial_failure = 3 [(.google.api.field_behavior) = REQUIRED];</code>
     *
     * @param  bool $var
     * @return $this
     */
    public function setPartialFailure($var)
    {
        GPBUtil::checkBool($var);
        $this->partial_failure = $var;

        return $this;
    }

    /**
     * If `true`, the request is validated but not executed. Only errors are
     * returned, not results.
     *
     * Generated from protobuf field <code>bool validate_only = 4;</code>
     *
     * @return bool
     */
    public function getValidateOnly()
    {
        return $this->validate_only;
    }

    /**
     * If `true`, the request is validated but not executed. Only errors are
     * returned, not results.
     *
     * Generated from protobuf field <code>bool validate_only = 4;</code>
     *
     * @param  bool $var
     * @return $this
     */
    public function setValidateOnly($var)
    {
        GPBUtil::checkBool($var);
        $this->validate_only = $var;

        return $this;
    }

    /**
     * Optional. Optional input to set job ID. Must be a non-negative number that
     * is less than 2^31 if provided. If this field is not provided, the API will
     * generate a job ID in the range [2^31, (2^63)-1]. The API will return the
     * value for this request in the `job_id` field of the
     * `UploadClickConversionsResponse`.
     *
     * Generated from protobuf field <code>optional int32 job_id = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
     *
     * @return int
     */
    public function getJobId()
    {
        return isset($this->job_id) ? $this->job_id : 0;
    }

    public function hasJobId()
    {
        return isset($this->job_id);
    }

    public function clearJobId()
    {
        unset($this->job_id);
    }

    /**
     * Optional. Optional input to set job ID. Must be a non-negative number that
     * is less than 2^31 if provided. If this field is not provided, the API will
     * generate a job ID in the range [2^31, (2^63)-1]. The API will return the
     * value for this request in the `job_id` field of the
     * `UploadClickConversionsResponse`.
     *
     * Generated from protobuf field <code>optional int32 job_id = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
     *
     * @param  int $var
     * @return $this
     */
    public function setJobId($var)
    {
        GPBUtil::checkInt32($var);
        $this->job_id = $var;

        return $this;
    }

}