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

namespace Google\Ads\GoogleAds\V23\Services;

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

/**
 * A plannable user list.
 *
 * Generated from protobuf message <code>google.ads.googleads.v23.services.PlannableUserList</code>
 */
class PlannableUserList extends \Google\Protobuf\Internal\Message
{
    /**
     * The user list ID.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.common.UserListInfo user_list_info = 1;</code>
     */
    protected $user_list_info = null;
    /**
     * The name of the user list.
     *
     * Generated from protobuf field <code>string display_name = 2;</code>
     */
    protected $display_name = '';
    /**
     * The user list type.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.enums.UserListTypeEnum.UserListType user_list_type = 3;</code>
     */
    protected $user_list_type = 0;
    /**
     * The plannable status of the user list.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.enums.ReachPlanPlannableUserListStatusEnum.ReachPlanPlannableUserListStatus plannable_status = 4;</code>
     */
    protected $plannable_status = 0;
    /**
     * The relevant metadata for this user list.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.services.PlannableUserListMetadata plannable_user_list_metadata = 5;</code>
     */
    protected $plannable_user_list_metadata = null;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type \Google\Ads\GoogleAds\V23\Common\UserListInfo $user_list_info
     *           The user list ID.
     *     @type string $display_name
     *           The name of the user list.
     *     @type int $user_list_type
     *           The user list type.
     *     @type int $plannable_status
     *           The plannable status of the user list.
     *     @type \Google\Ads\GoogleAds\V23\Services\PlannableUserListMetadata $plannable_user_list_metadata
     *           The relevant metadata for this user list.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Ads\GoogleAds\V23\Services\ReachPlanService::initOnce();
        parent::__construct($data);
    }

    /**
     * The user list ID.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.common.UserListInfo user_list_info = 1;</code>
     * @return \Google\Ads\GoogleAds\V23\Common\UserListInfo|null
     */
    public function getUserListInfo()
    {
        return $this->user_list_info;
    }

    public function hasUserListInfo()
    {
        return isset($this->user_list_info);
    }

    public function clearUserListInfo()
    {
        unset($this->user_list_info);
    }

    /**
     * The user list ID.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.common.UserListInfo user_list_info = 1;</code>
     * @param \Google\Ads\GoogleAds\V23\Common\UserListInfo $var
     * @return $this
     */
    public function setUserListInfo($var)
    {
        GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\UserListInfo::class);
        $this->user_list_info = $var;

        return $this;
    }

    /**
     * The name of the user list.
     *
     * Generated from protobuf field <code>string display_name = 2;</code>
     * @return string
     */
    public function getDisplayName()
    {
        return $this->display_name;
    }

    /**
     * The name of the user list.
     *
     * Generated from protobuf field <code>string display_name = 2;</code>
     * @param string $var
     * @return $this
     */
    public function setDisplayName($var)
    {
        GPBUtil::checkString($var, True);
        $this->display_name = $var;

        return $this;
    }

    /**
     * The user list type.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.enums.UserListTypeEnum.UserListType user_list_type = 3;</code>
     * @return int
     */
    public function getUserListType()
    {
        return $this->user_list_type;
    }

    /**
     * The user list type.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.enums.UserListTypeEnum.UserListType user_list_type = 3;</code>
     * @param int $var
     * @return $this
     */
    public function setUserListType($var)
    {
        GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\UserListTypeEnum\UserListType::class);
        $this->user_list_type = $var;

        return $this;
    }

    /**
     * The plannable status of the user list.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.enums.ReachPlanPlannableUserListStatusEnum.ReachPlanPlannableUserListStatus plannable_status = 4;</code>
     * @return int
     */
    public function getPlannableStatus()
    {
        return $this->plannable_status;
    }

    /**
     * The plannable status of the user list.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.enums.ReachPlanPlannableUserListStatusEnum.ReachPlanPlannableUserListStatus plannable_status = 4;</code>
     * @param int $var
     * @return $this
     */
    public function setPlannableStatus($var)
    {
        GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\ReachPlanPlannableUserListStatusEnum\ReachPlanPlannableUserListStatus::class);
        $this->plannable_status = $var;

        return $this;
    }

    /**
     * The relevant metadata for this user list.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.services.PlannableUserListMetadata plannable_user_list_metadata = 5;</code>
     * @return \Google\Ads\GoogleAds\V23\Services\PlannableUserListMetadata|null
     */
    public function getPlannableUserListMetadata()
    {
        return $this->plannable_user_list_metadata;
    }

    public function hasPlannableUserListMetadata()
    {
        return isset($this->plannable_user_list_metadata);
    }

    public function clearPlannableUserListMetadata()
    {
        unset($this->plannable_user_list_metadata);
    }

    /**
     * The relevant metadata for this user list.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.services.PlannableUserListMetadata plannable_user_list_metadata = 5;</code>
     * @param \Google\Ads\GoogleAds\V23\Services\PlannableUserListMetadata $var
     * @return $this
     */
    public function setPlannableUserListMetadata($var)
    {
        GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Services\PlannableUserListMetadata::class);
        $this->plannable_user_list_metadata = $var;

        return $this;
    }

}

