<?php
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v23/resources/shared_set.proto

namespace Google\Ads\GoogleAds\V23\Resources;

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

/**
 * SharedSets are used for sharing criterion exclusions across multiple
 * campaigns.
 *
 * Generated from protobuf message <code>google.ads.googleads.v23.resources.SharedSet</code>
 */
class SharedSet extends \Google\Protobuf\Internal\Message
{
    /**
     * Immutable. The resource name of the shared set.
     * Shared set resource names have the form:
     * `customers/{customer_id}/sharedSets/{shared_set_id}`
     *
     * Generated from protobuf field <code>string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = {</code>
     */
    protected $resource_name = '';
    /**
     * Output only. The ID of this shared set. Read only.
     *
     * Generated from protobuf field <code>optional int64 id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     */
    protected $id = null;
    /**
     * Immutable. The type of this shared set: each shared set holds only a single
     * kind of resource. Required. Immutable.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.enums.SharedSetTypeEnum.SharedSetType type = 3 [(.google.api.field_behavior) = IMMUTABLE];</code>
     */
    protected $type = 0;
    /**
     * The name of this shared set. Required.
     * Shared Sets must have names that are unique among active shared sets of
     * the same type.
     * The length of this string should be between 1 and 255 UTF-8 bytes,
     * inclusive.
     *
     * Generated from protobuf field <code>optional string name = 9;</code>
     */
    protected $name = null;
    /**
     * Output only. The status of this shared set. Read only.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.enums.SharedSetStatusEnum.SharedSetStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     */
    protected $status = 0;
    /**
     * Output only. The number of shared criteria within this shared set. Read
     * only.
     *
     * Generated from protobuf field <code>optional int64 member_count = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     */
    protected $member_count = null;
    /**
     * Output only. The number of campaigns associated with this shared set. Read
     * only.
     *
     * Generated from protobuf field <code>optional int64 reference_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     */
    protected $reference_count = null;
    /**
     * Immutable. Shared sets of type VERTICAL_ADS_ITEM_GROUP_RULE_LIST are
     * associated with a particular vertical (e.g. hotels, things to do, flights,
     * etc.). This field is required for shared sets of type
     * VERTICAL_ADS_ITEM_GROUP_RULE_LIST.
     *
     * Generated from protobuf field <code>optional .google.ads.googleads.v23.enums.VerticalAdsItemVerticalTypeEnum.VerticalAdsItemVerticalType vertical_ads_item_vertical_type = 12 [(.google.api.field_behavior) = IMMUTABLE];</code>
     */
    protected $vertical_ads_item_vertical_type = null;

    /**
     * Constructor.
     *
     * @param array $data {
     *                    Optional. Data for populating the Message object.
     *
     * @type string $resource_name
     *           Immutable. The resource name of the shared set.
     *           Shared set resource names have the form:
     *           `customers/{customer_id}/sharedSets/{shared_set_id}`
     * @type int|string $id
     *           Output only. The ID of this shared set. Read only.
     * @type int $type
     *           Immutable. The type of this shared set: each shared set holds only a single
     *           kind of resource. Required. Immutable.
     * @type string $name
     *           The name of this shared set. Required.
     *           Shared Sets must have names that are unique among active shared sets of
     *           the same type.
     *           The length of this string should be between 1 and 255 UTF-8 bytes,
     *           inclusive.
     * @type int $status
     *           Output only. The status of this shared set. Read only.
     * @type int|string $member_count
     *           Output only. The number of shared criteria within this shared set. Read
     *           only.
     * @type int|string $reference_count
     *           Output only. The number of campaigns associated with this shared set. Read
     *           only.
     * @type int $vertical_ads_item_vertical_type
     *           Immutable. Shared sets of type VERTICAL_ADS_ITEM_GROUP_RULE_LIST are
     *           associated with a particular vertical (e.g. hotels, things to do, flights,
     *           etc.). This field is required for shared sets of type
     *           VERTICAL_ADS_ITEM_GROUP_RULE_LIST.
     * }
     */
    public function __construct($data = null)
    {
        \GPBMetadata\Google\Ads\GoogleAds\V23\Resources\SharedSet::initOnce();
        parent::__construct($data);
    }

    /**
     * Immutable. The resource name of the shared set.
     * Shared set resource names have the form:
     * `customers/{customer_id}/sharedSets/{shared_set_id}`
     *
     * Generated from protobuf field <code>string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = {</code>
     *
     * @return string
     */
    public function getResourceName()
    {
        return $this->resource_name;
    }

    /**
     * Immutable. The resource name of the shared set.
     * Shared set resource names have the form:
     * `customers/{customer_id}/sharedSets/{shared_set_id}`
     *
     * Generated from protobuf field <code>string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = {</code>
     *
     * @param  string $var
     * @return $this
     */
    public function setResourceName($var)
    {
        GPBUtil::checkString($var, true);
        $this->resource_name = $var;

        return $this;
    }

    /**
     * Output only. The ID of this shared set. Read only.
     *
     * Generated from protobuf field <code>optional int64 id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     *
     * @return int|string
     */
    public function getId()
    {
        return isset($this->id) ? $this->id : 0;
    }

    public function hasId()
    {
        return isset($this->id);
    }

    public function clearId()
    {
        unset($this->id);
    }

    /**
     * Output only. The ID of this shared set. Read only.
     *
     * Generated from protobuf field <code>optional int64 id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     *
     * @param  int|string $var
     * @return $this
     */
    public function setId($var)
    {
        GPBUtil::checkInt64($var);
        $this->id = $var;

        return $this;
    }

    /**
     * Immutable. The type of this shared set: each shared set holds only a single
     * kind of resource. Required. Immutable.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.enums.SharedSetTypeEnum.SharedSetType type = 3 [(.google.api.field_behavior) = IMMUTABLE];</code>
     *
     * @return int
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * Immutable. The type of this shared set: each shared set holds only a single
     * kind of resource. Required. Immutable.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.enums.SharedSetTypeEnum.SharedSetType type = 3 [(.google.api.field_behavior) = IMMUTABLE];</code>
     *
     * @param  int $var
     * @return $this
     */
    public function setType($var)
    {
        GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\SharedSetTypeEnum\SharedSetType::class);
        $this->type = $var;

        return $this;
    }

    /**
     * The name of this shared set. Required.
     * Shared Sets must have names that are unique among active shared sets of
     * the same type.
     * The length of this string should be between 1 and 255 UTF-8 bytes,
     * inclusive.
     *
     * Generated from protobuf field <code>optional string name = 9;</code>
     *
     * @return string
     */
    public function getName()
    {
        return isset($this->name) ? $this->name : '';
    }

    public function hasName()
    {
        return isset($this->name);
    }

    public function clearName()
    {
        unset($this->name);
    }

    /**
     * The name of this shared set. Required.
     * Shared Sets must have names that are unique among active shared sets of
     * the same type.
     * The length of this string should be between 1 and 255 UTF-8 bytes,
     * inclusive.
     *
     * Generated from protobuf field <code>optional string name = 9;</code>
     *
     * @param  string $var
     * @return $this
     */
    public function setName($var)
    {
        GPBUtil::checkString($var, true);
        $this->name = $var;

        return $this;
    }

    /**
     * Output only. The status of this shared set. Read only.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.enums.SharedSetStatusEnum.SharedSetStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     *
     * @return int
     */
    public function getStatus()
    {
        return $this->status;
    }

    /**
     * Output only. The status of this shared set. Read only.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.enums.SharedSetStatusEnum.SharedSetStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     *
     * @param  int $var
     * @return $this
     */
    public function setStatus($var)
    {
        GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\SharedSetStatusEnum\SharedSetStatus::class);
        $this->status = $var;

        return $this;
    }

    /**
     * Output only. The number of shared criteria within this shared set. Read
     * only.
     *
     * Generated from protobuf field <code>optional int64 member_count = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     *
     * @return int|string
     */
    public function getMemberCount()
    {
        return isset($this->member_count) ? $this->member_count : 0;
    }

    public function hasMemberCount()
    {
        return isset($this->member_count);
    }

    public function clearMemberCount()
    {
        unset($this->member_count);
    }

    /**
     * Output only. The number of shared criteria within this shared set. Read
     * only.
     *
     * Generated from protobuf field <code>optional int64 member_count = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     *
     * @param  int|string $var
     * @return $this
     */
    public function setMemberCount($var)
    {
        GPBUtil::checkInt64($var);
        $this->member_count = $var;

        return $this;
    }

    /**
     * Output only. The number of campaigns associated with this shared set. Read
     * only.
     *
     * Generated from protobuf field <code>optional int64 reference_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     *
     * @return int|string
     */
    public function getReferenceCount()
    {
        return isset($this->reference_count) ? $this->reference_count : 0;
    }

    public function hasReferenceCount()
    {
        return isset($this->reference_count);
    }

    public function clearReferenceCount()
    {
        unset($this->reference_count);
    }

    /**
     * Output only. The number of campaigns associated with this shared set. Read
     * only.
     *
     * Generated from protobuf field <code>optional int64 reference_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     *
     * @param  int|string $var
     * @return $this
     */
    public function setReferenceCount($var)
    {
        GPBUtil::checkInt64($var);
        $this->reference_count = $var;

        return $this;
    }

    /**
     * Immutable. Shared sets of type VERTICAL_ADS_ITEM_GROUP_RULE_LIST are
     * associated with a particular vertical (e.g. hotels, things to do, flights,
     * etc.). This field is required for shared sets of type
     * VERTICAL_ADS_ITEM_GROUP_RULE_LIST.
     *
     * Generated from protobuf field <code>optional .google.ads.googleads.v23.enums.VerticalAdsItemVerticalTypeEnum.VerticalAdsItemVerticalType vertical_ads_item_vertical_type = 12 [(.google.api.field_behavior) = IMMUTABLE];</code>
     *
     * @return int
     */
    public function getVerticalAdsItemVerticalType()
    {
        return isset($this->vertical_ads_item_vertical_type) ? $this->vertical_ads_item_vertical_type : 0;
    }

    public function hasVerticalAdsItemVerticalType()
    {
        return isset($this->vertical_ads_item_vertical_type);
    }

    public function clearVerticalAdsItemVerticalType()
    {
        unset($this->vertical_ads_item_vertical_type);
    }

    /**
     * Immutable. Shared sets of type VERTICAL_ADS_ITEM_GROUP_RULE_LIST are
     * associated with a particular vertical (e.g. hotels, things to do, flights,
     * etc.). This field is required for shared sets of type
     * VERTICAL_ADS_ITEM_GROUP_RULE_LIST.
     *
     * Generated from protobuf field <code>optional .google.ads.googleads.v23.enums.VerticalAdsItemVerticalTypeEnum.VerticalAdsItemVerticalType vertical_ads_item_vertical_type = 12 [(.google.api.field_behavior) = IMMUTABLE];</code>
     *
     * @param  int $var
     * @return $this
     */
    public function setVerticalAdsItemVerticalType($var)
    {
        GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\VerticalAdsItemVerticalTypeEnum\VerticalAdsItemVerticalType::class);
        $this->vertical_ads_item_vertical_type = $var;

        return $this;
    }

}