|
| 1 | +/* |
| 2 | + * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except |
| 3 | + * in compliance with the License. You may obtain a copy of the License at |
| 4 | + * |
| 5 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 6 | + * |
| 7 | + * Unless required by applicable law or agreed to in writing, software distributed under the License |
| 8 | + * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express |
| 9 | + * or implied. See the License for the specific language governing permissions and limitations under |
| 10 | + * the License. |
| 11 | + */ |
| 12 | +/* |
| 13 | + * This code was generated by https://github.com/googleapis/google-api-java-client-services/ |
| 14 | + * Modify at your own risk. |
| 15 | + */ |
| 16 | + |
| 17 | +package com.google.api.services.docs.v1.model; |
| 18 | + |
| 19 | +/** |
| 20 | + * Properties of a DateElement. |
| 21 | + * |
| 22 | + * <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is |
| 23 | + * transmitted over HTTP when working with the Google Docs API. For a detailed explanation see: |
| 24 | + * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a> |
| 25 | + * </p> |
| 26 | + * |
| 27 | + * @author Google, Inc. |
| 28 | + */ |
| 29 | +@SuppressWarnings("javadoc") |
| 30 | +public final class DateElementProperties extends com.google.api.client.json.GenericJson { |
| 31 | + |
| 32 | + /** |
| 33 | + * Determines how the date part of the DateElement will be displayed in the document. If unset, |
| 34 | + * the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be |
| 35 | + * formatted as `MMM d, y` in `en_US`, or locale specific equivalent. |
| 36 | + * The value may be {@code null}. |
| 37 | + */ |
| 38 | + @com.google.api.client.util.Key |
| 39 | + private java.lang.String dateFormat; |
| 40 | + |
| 41 | + /** |
| 42 | + * Output only. Indicates how the DateElement is displayed in the document. |
| 43 | + * The value may be {@code null}. |
| 44 | + */ |
| 45 | + @com.google.api.client.util.Key |
| 46 | + private java.lang.String displayText; |
| 47 | + |
| 48 | + /** |
| 49 | + * The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) |
| 50 | + * project. For example, `en_US`. If unset, the default locale is `en_US`. |
| 51 | + * The value may be {@code null}. |
| 52 | + */ |
| 53 | + @com.google.api.client.util.Key |
| 54 | + private java.lang.String locale; |
| 55 | + |
| 56 | + /** |
| 57 | + * Determines how the time part of the DateElement will be displayed in the document. If unset, |
| 58 | + * the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. |
| 59 | + * The value may be {@code null}. |
| 60 | + */ |
| 61 | + @com.google.api.client.util.Key |
| 62 | + private java.lang.String timeFormat; |
| 63 | + |
| 64 | + /** |
| 65 | + * The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository |
| 66 | + * (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. |
| 67 | + * The value may be {@code null}. |
| 68 | + */ |
| 69 | + @com.google.api.client.util.Key |
| 70 | + private java.lang.String timeZoneId; |
| 71 | + |
| 72 | + /** |
| 73 | + * The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at |
| 74 | + * midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is |
| 75 | + * adjusted according to the time zone. For example, a timestamp of `18000` with a date format of |
| 76 | + * `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as |
| 77 | + * `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time |
| 78 | + * format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be |
| 79 | + * `1970-01-01 12:00 AM`. |
| 80 | + * The value may be {@code null}. |
| 81 | + */ |
| 82 | + @com.google.api.client.util.Key |
| 83 | + private String timestamp; |
| 84 | + |
| 85 | + /** |
| 86 | + * Determines how the date part of the DateElement will be displayed in the document. If unset, |
| 87 | + * the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be |
| 88 | + * formatted as `MMM d, y` in `en_US`, or locale specific equivalent. |
| 89 | + * @return value or {@code null} for none |
| 90 | + */ |
| 91 | + public java.lang.String getDateFormat() { |
| 92 | + return dateFormat; |
| 93 | + } |
| 94 | + |
| 95 | + /** |
| 96 | + * Determines how the date part of the DateElement will be displayed in the document. If unset, |
| 97 | + * the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be |
| 98 | + * formatted as `MMM d, y` in `en_US`, or locale specific equivalent. |
| 99 | + * @param dateFormat dateFormat or {@code null} for none |
| 100 | + */ |
| 101 | + public DateElementProperties setDateFormat(java.lang.String dateFormat) { |
| 102 | + this.dateFormat = dateFormat; |
| 103 | + return this; |
| 104 | + } |
| 105 | + |
| 106 | + /** |
| 107 | + * Output only. Indicates how the DateElement is displayed in the document. |
| 108 | + * @return value or {@code null} for none |
| 109 | + */ |
| 110 | + public java.lang.String getDisplayText() { |
| 111 | + return displayText; |
| 112 | + } |
| 113 | + |
| 114 | + /** |
| 115 | + * Output only. Indicates how the DateElement is displayed in the document. |
| 116 | + * @param displayText displayText or {@code null} for none |
| 117 | + */ |
| 118 | + public DateElementProperties setDisplayText(java.lang.String displayText) { |
| 119 | + this.displayText = displayText; |
| 120 | + return this; |
| 121 | + } |
| 122 | + |
| 123 | + /** |
| 124 | + * The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) |
| 125 | + * project. For example, `en_US`. If unset, the default locale is `en_US`. |
| 126 | + * @return value or {@code null} for none |
| 127 | + */ |
| 128 | + public java.lang.String getLocale() { |
| 129 | + return locale; |
| 130 | + } |
| 131 | + |
| 132 | + /** |
| 133 | + * The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) |
| 134 | + * project. For example, `en_US`. If unset, the default locale is `en_US`. |
| 135 | + * @param locale locale or {@code null} for none |
| 136 | + */ |
| 137 | + public DateElementProperties setLocale(java.lang.String locale) { |
| 138 | + this.locale = locale; |
| 139 | + return this; |
| 140 | + } |
| 141 | + |
| 142 | + /** |
| 143 | + * Determines how the time part of the DateElement will be displayed in the document. If unset, |
| 144 | + * the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. |
| 145 | + * @return value or {@code null} for none |
| 146 | + */ |
| 147 | + public java.lang.String getTimeFormat() { |
| 148 | + return timeFormat; |
| 149 | + } |
| 150 | + |
| 151 | + /** |
| 152 | + * Determines how the time part of the DateElement will be displayed in the document. If unset, |
| 153 | + * the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. |
| 154 | + * @param timeFormat timeFormat or {@code null} for none |
| 155 | + */ |
| 156 | + public DateElementProperties setTimeFormat(java.lang.String timeFormat) { |
| 157 | + this.timeFormat = timeFormat; |
| 158 | + return this; |
| 159 | + } |
| 160 | + |
| 161 | + /** |
| 162 | + * The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository |
| 163 | + * (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. |
| 164 | + * @return value or {@code null} for none |
| 165 | + */ |
| 166 | + public java.lang.String getTimeZoneId() { |
| 167 | + return timeZoneId; |
| 168 | + } |
| 169 | + |
| 170 | + /** |
| 171 | + * The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository |
| 172 | + * (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. |
| 173 | + * @param timeZoneId timeZoneId or {@code null} for none |
| 174 | + */ |
| 175 | + public DateElementProperties setTimeZoneId(java.lang.String timeZoneId) { |
| 176 | + this.timeZoneId = timeZoneId; |
| 177 | + return this; |
| 178 | + } |
| 179 | + |
| 180 | + /** |
| 181 | + * The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at |
| 182 | + * midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is |
| 183 | + * adjusted according to the time zone. For example, a timestamp of `18000` with a date format of |
| 184 | + * `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as |
| 185 | + * `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time |
| 186 | + * format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be |
| 187 | + * `1970-01-01 12:00 AM`. |
| 188 | + * @return value or {@code null} for none |
| 189 | + */ |
| 190 | + public String getTimestamp() { |
| 191 | + return timestamp; |
| 192 | + } |
| 193 | + |
| 194 | + /** |
| 195 | + * The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at |
| 196 | + * midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is |
| 197 | + * adjusted according to the time zone. For example, a timestamp of `18000` with a date format of |
| 198 | + * `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as |
| 199 | + * `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time |
| 200 | + * format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be |
| 201 | + * `1970-01-01 12:00 AM`. |
| 202 | + * @param timestamp timestamp or {@code null} for none |
| 203 | + */ |
| 204 | + public DateElementProperties setTimestamp(String timestamp) { |
| 205 | + this.timestamp = timestamp; |
| 206 | + return this; |
| 207 | + } |
| 208 | + |
| 209 | + @Override |
| 210 | + public DateElementProperties set(String fieldName, Object value) { |
| 211 | + return (DateElementProperties) super.set(fieldName, value); |
| 212 | + } |
| 213 | + |
| 214 | + @Override |
| 215 | + public DateElementProperties clone() { |
| 216 | + return (DateElementProperties) super.clone(); |
| 217 | + } |
| 218 | + |
| 219 | +} |
0 commit comments