Field.php 9.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/protobuf/type.proto

namespace Google\Protobuf;

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

/**
 * A single field of a message type.
 *
 * Generated from protobuf message <code>google.protobuf.Field</code>
 */
class Field extends \Google\Protobuf\Internal\Message
{
    /**
     * The field type.
     *
     * Generated from protobuf field <code>.google.protobuf.Field.Kind kind = 1;</code>
     */
    private $kind = 0;
    /**
     * The field cardinality.
     *
     * Generated from protobuf field <code>.google.protobuf.Field.Cardinality cardinality = 2;</code>
     */
    private $cardinality = 0;
    /**
     * The field number.
     *
     * Generated from protobuf field <code>int32 number = 3;</code>
     */
    private $number = 0;
    /**
     * The field name.
     *
     * Generated from protobuf field <code>string name = 4;</code>
     */
    private $name = '';
    /**
     * The field type URL, without the scheme, for message or enumeration
     * types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
     *
     * Generated from protobuf field <code>string type_url = 6;</code>
     */
    private $type_url = '';
    /**
     * The index of the field type in `Type.oneofs`, for message or enumeration
     * types. The first type has index 1; zero means the type is not in the list.
     *
     * Generated from protobuf field <code>int32 oneof_index = 7;</code>
     */
    private $oneof_index = 0;
    /**
     * Whether to use alternative packed wire representation.
     *
     * Generated from protobuf field <code>bool packed = 8;</code>
     */
    private $packed = false;
    /**
     * The protocol buffer options.
     *
     * Generated from protobuf field <code>repeated .google.protobuf.Option options = 9;</code>
     */
    private $options;
    /**
     * The field JSON name.
     *
     * Generated from protobuf field <code>string json_name = 10;</code>
     */
    private $json_name = '';
    /**
     * The string value of the default value of this field. Proto2 syntax only.
     *
     * Generated from protobuf field <code>string default_value = 11;</code>
     */
    private $default_value = '';

81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type int $kind
     *           The field type.
     *     @type int $cardinality
     *           The field cardinality.
     *     @type int $number
     *           The field number.
     *     @type string $name
     *           The field name.
     *     @type string $type_url
     *           The field type URL, without the scheme, for message or enumeration
     *           types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
     *     @type int $oneof_index
     *           The index of the field type in `Type.oneofs`, for message or enumeration
     *           types. The first type has index 1; zero means the type is not in the list.
     *     @type bool $packed
     *           Whether to use alternative packed wire representation.
     *     @type \Google\Protobuf\Option[]|\Google\Protobuf\Internal\RepeatedField $options
     *           The protocol buffer options.
     *     @type string $json_name
     *           The field JSON name.
     *     @type string $default_value
     *           The string value of the default value of this field. Proto2 syntax only.
     * }
     */
    public function __construct($data = NULL) {
112
        \GPBMetadata\Google\Protobuf\Type::initOnce();
113
        parent::__construct($data);
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
    }

    /**
     * The field type.
     *
     * Generated from protobuf field <code>.google.protobuf.Field.Kind kind = 1;</code>
     * @return int
     */
    public function getKind()
    {
        return $this->kind;
    }

    /**
     * The field type.
     *
     * Generated from protobuf field <code>.google.protobuf.Field.Kind kind = 1;</code>
     * @param int $var
     * @return $this
     */
    public function setKind($var)
    {
        GPBUtil::checkEnum($var, \Google\Protobuf\Field_Kind::class);
        $this->kind = $var;

        return $this;
    }

    /**
     * The field cardinality.
     *
     * Generated from protobuf field <code>.google.protobuf.Field.Cardinality cardinality = 2;</code>
     * @return int
     */
    public function getCardinality()
    {
        return $this->cardinality;
    }

    /**
     * The field cardinality.
     *
     * Generated from protobuf field <code>.google.protobuf.Field.Cardinality cardinality = 2;</code>
     * @param int $var
     * @return $this
     */
    public function setCardinality($var)
    {
        GPBUtil::checkEnum($var, \Google\Protobuf\Field_Cardinality::class);
        $this->cardinality = $var;

        return $this;
    }

    /**
     * The field number.
     *
     * Generated from protobuf field <code>int32 number = 3;</code>
     * @return int
     */
    public function getNumber()
    {
        return $this->number;
    }

    /**
     * The field number.
     *
     * Generated from protobuf field <code>int32 number = 3;</code>
     * @param int $var
     * @return $this
     */
    public function setNumber($var)
    {
        GPBUtil::checkInt32($var);
        $this->number = $var;

        return $this;
    }

    /**
     * The field name.
     *
     * Generated from protobuf field <code>string name = 4;</code>
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * The field name.
     *
     * Generated from protobuf field <code>string name = 4;</code>
     * @param string $var
     * @return $this
     */
    public function setName($var)
    {
        GPBUtil::checkString($var, True);
        $this->name = $var;

        return $this;
    }

    /**
     * The field type URL, without the scheme, for message or enumeration
     * types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
     *
     * Generated from protobuf field <code>string type_url = 6;</code>
     * @return string
     */
    public function getTypeUrl()
    {
        return $this->type_url;
    }

    /**
     * The field type URL, without the scheme, for message or enumeration
     * types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
     *
     * Generated from protobuf field <code>string type_url = 6;</code>
     * @param string $var
     * @return $this
     */
    public function setTypeUrl($var)
    {
        GPBUtil::checkString($var, True);
        $this->type_url = $var;

        return $this;
    }

    /**
     * The index of the field type in `Type.oneofs`, for message or enumeration
     * types. The first type has index 1; zero means the type is not in the list.
     *
     * Generated from protobuf field <code>int32 oneof_index = 7;</code>
     * @return int
     */
    public function getOneofIndex()
    {
        return $this->oneof_index;
    }

    /**
     * The index of the field type in `Type.oneofs`, for message or enumeration
     * types. The first type has index 1; zero means the type is not in the list.
     *
     * Generated from protobuf field <code>int32 oneof_index = 7;</code>
     * @param int $var
     * @return $this
     */
    public function setOneofIndex($var)
    {
        GPBUtil::checkInt32($var);
        $this->oneof_index = $var;

        return $this;
    }

    /**
     * Whether to use alternative packed wire representation.
     *
     * Generated from protobuf field <code>bool packed = 8;</code>
     * @return bool
     */
    public function getPacked()
    {
        return $this->packed;
    }

    /**
     * Whether to use alternative packed wire representation.
     *
     * Generated from protobuf field <code>bool packed = 8;</code>
     * @param bool $var
     * @return $this
     */
    public function setPacked($var)
    {
        GPBUtil::checkBool($var);
        $this->packed = $var;

        return $this;
    }

    /**
     * The protocol buffer options.
     *
     * Generated from protobuf field <code>repeated .google.protobuf.Option options = 9;</code>
     * @return \Google\Protobuf\Internal\RepeatedField
     */
    public function getOptions()
    {
        return $this->options;
    }

    /**
     * The protocol buffer options.
     *
     * Generated from protobuf field <code>repeated .google.protobuf.Option options = 9;</code>
     * @param \Google\Protobuf\Option[]|\Google\Protobuf\Internal\RepeatedField $var
     * @return $this
     */
    public function setOptions($var)
    {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Protobuf\Option::class);
        $this->options = $arr;

        return $this;
    }

    /**
     * The field JSON name.
     *
     * Generated from protobuf field <code>string json_name = 10;</code>
     * @return string
     */
    public function getJsonName()
    {
        return $this->json_name;
    }

    /**
     * The field JSON name.
     *
     * Generated from protobuf field <code>string json_name = 10;</code>
     * @param string $var
     * @return $this
     */
    public function setJsonName($var)
    {
        GPBUtil::checkString($var, True);
        $this->json_name = $var;

        return $this;
    }

    /**
     * The string value of the default value of this field. Proto2 syntax only.
     *
     * Generated from protobuf field <code>string default_value = 11;</code>
     * @return string
     */
    public function getDefaultValue()
    {
        return $this->default_value;
    }

    /**
     * The string value of the default value of this field. Proto2 syntax only.
     *
     * Generated from protobuf field <code>string default_value = 11;</code>
     * @param string $var
     * @return $this
     */
    public function setDefaultValue($var)
    {
        GPBUtil::checkString($var, True);
        $this->default_value = $var;

        return $this;
    }

}