google-cloud-php/BigQueryStorage/src/V1/AvroSerializationOptions.php at 6f2a002c5a0f05ac9aae8bebc2eca76ffcaaf974 · googleapis/google-cloud-php · GitHub

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
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/cloud/bigquery/storage/v1/avro.proto

namespace Google\Cloud\BigQuery\Storage\V1;

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

/**
 * Contains options specific to Avro Serialization.
 *
 * Generated from protobuf message <code>google.cloud.bigquery.storage.v1.AvroSerializationOptions</code>
 */
class AvroSerializationOptions extends \Google\Protobuf\Internal\Message
{
    /**
     * Enable displayName attribute in Avro schema.
     * The Avro specification requires field names to be alphanumeric.  By
     * default, in cases when column names do not conform to these requirements
     * (e.g. non-ascii unicode codepoints) and Avro is requested as an output
     * format, the CreateReadSession call will fail.
     * Setting this field to true, populates avro field names with a placeholder
     * value and populates a "displayName" attribute for every avro field with the
     * original column name.
     *
     * Generated from protobuf field <code>bool enable_display_name_attribute = 1;</code>
     */
    protected $enable_display_name_attribute = false;
    /**
     * Optional. Set timestamp precision option. If not set, the default precision
     * is microseconds.
     *
     * Generated from protobuf field <code>.google.cloud.bigquery.storage.v1.AvroSerializationOptions.PicosTimestampPrecision picos_timestamp_precision = 2;</code>
     */
    protected $picos_timestamp_precision = 0;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type bool $enable_display_name_attribute
     *           Enable displayName attribute in Avro schema.
     *           The Avro specification requires field names to be alphanumeric.  By
     *           default, in cases when column names do not conform to these requirements
     *           (e.g. non-ascii unicode codepoints) and Avro is requested as an output
     *           format, the CreateReadSession call will fail.
     *           Setting this field to true, populates avro field names with a placeholder
     *           value and populates a "displayName" attribute for every avro field with the
     *           original column name.
     *     @type int $picos_timestamp_precision
     *           Optional. Set timestamp precision option. If not set, the default precision
     *           is microseconds.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Bigquery\Storage\V1\Avro::initOnce();
        parent::__construct($data);
    }

    /**
     * Enable displayName attribute in Avro schema.
     * The Avro specification requires field names to be alphanumeric.  By
     * default, in cases when column names do not conform to these requirements
     * (e.g. non-ascii unicode codepoints) and Avro is requested as an output
     * format, the CreateReadSession call will fail.
     * Setting this field to true, populates avro field names with a placeholder
     * value and populates a "displayName" attribute for every avro field with the
     * original column name.
     *
     * Generated from protobuf field <code>bool enable_display_name_attribute = 1;</code>
     * @return bool
     */
    public function getEnableDisplayNameAttribute()
    {
        return $this->enable_display_name_attribute;
    }

    /**
     * Enable displayName attribute in Avro schema.
     * The Avro specification requires field names to be alphanumeric.  By
     * default, in cases when column names do not conform to these requirements
     * (e.g. non-ascii unicode codepoints) and Avro is requested as an output
     * format, the CreateReadSession call will fail.
     * Setting this field to true, populates avro field names with a placeholder
     * value and populates a "displayName" attribute for every avro field with the
     * original column name.
     *
     * Generated from protobuf field <code>bool enable_display_name_attribute = 1;</code>
     * @param bool $var
     * @return $this
     */
    public function setEnableDisplayNameAttribute($var)
    {
        GPBUtil::checkBool($var);
        $this->enable_display_name_attribute = $var;

        return $this;
    }

    /**
     * Optional. Set timestamp precision option. If not set, the default precision
     * is microseconds.
     *
     * Generated from protobuf field <code>.google.cloud.bigquery.storage.v1.AvroSerializationOptions.PicosTimestampPrecision picos_timestamp_precision = 2;</code>
     * @return int
     */
    public function getPicosTimestampPrecision()
    {
        return $this->picos_timestamp_precision;
    }

    /**
     * Optional. Set timestamp precision option. If not set, the default precision
     * is microseconds.
     *
     * Generated from protobuf field <code>.google.cloud.bigquery.storage.v1.AvroSerializationOptions.PicosTimestampPrecision picos_timestamp_precision = 2;</code>
     * @param int $var
     * @return $this
     */
    public function setPicosTimestampPrecision($var)
    {
        GPBUtil::checkEnum($var, \Google\Cloud\BigQuery\Storage\V1\AvroSerializationOptions\PicosTimestampPrecision::class);
        $this->picos_timestamp_precision = $var;

        return $this;
    }

}