com.google.api.services.docs.v1.model

Class DateElementProperties

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.docs.v1.model.DateElementProperties

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class DateElementProperties
extends com.google.api.client.json.GenericJson

Properties of a DateElement.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Docs API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
DateElementProperties()

Method Summary

Modifier and Type	Method and Description
DateElementProperties	clone()
String	getDateFormat() Determines how the date part of the DateElement will be displayed in the document.
String	getDisplayText() Output only.
String	getLocale() The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project.
String	getTimeFormat() Determines how the time part of the DateElement will be displayed in the document.
String	getTimestamp() The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC.
String	getTimeZoneId() The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project.
DateElementProperties	set(String fieldName, Object value)
DateElementProperties	setDateFormat(String dateFormat) Determines how the date part of the DateElement will be displayed in the document.
DateElementProperties	setDisplayText(String displayText) Output only.
DateElementProperties	setLocale(String locale) The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project.
DateElementProperties	setTimeFormat(String timeFormat) Determines how the time part of the DateElement will be displayed in the document.
DateElementProperties	setTimestamp(String timestamp) The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC.
DateElementProperties	setTimeZoneId(String timeZoneId) The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

DateElementProperties

public DateElementProperties()

Method Detail

getDateFormat

public String getDateFormat()

Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent.

Returns:

value or null for none

setDateFormat

public DateElementProperties setDateFormat(String dateFormat)

Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent.

Parameters:

dateFormat - dateFormat or null for none

getDisplayText

public String getDisplayText()

Output only. Indicates how the DateElement is displayed in the document.

Returns:

value or null for none

setDisplayText

public DateElementProperties setDisplayText(String displayText)

Output only. Indicates how the DateElement is displayed in the document.

Parameters:

displayText - displayText or null for none

getLocale

public String getLocale()

The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`.

Returns:

value or null for none

setLocale

public DateElementProperties setLocale(String locale)

The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`.

Parameters:

locale - locale or null for none

getTimeFormat

public String getTimeFormat()

Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown.

Returns:

value or null for none

setTimeFormat

public DateElementProperties setTimeFormat(String timeFormat)

Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown.

Parameters:

timeFormat - timeFormat or null for none

getTimeZoneId

public String getTimeZoneId()

The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`.

Returns:

value or null for none

setTimeZoneId

public DateElementProperties setTimeZoneId(String timeZoneId)

The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`.

Parameters:

timeZoneId - timeZoneId or null for none

getTimestamp

public String getTimestamp()

The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`.

Returns:

value or null for none

setTimestamp

public DateElementProperties setTimestamp(String timestamp)

The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`.

Parameters:

timestamp - timestamp or null for none

set

public DateElementProperties set(String fieldName,
                                 Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public DateElementProperties clone()

Overrides:

clone in class com.google.api.client.json.GenericJson