package google.type

Get desktop application:
View/edit binary Protocol Buffers messages

A `CalendarPeriod` represents the abstract concept of a time period that has a canonical start. Grammatically, "the start of the current `CalendarPeriod`." All calendar times begin at midnight UTC.

• CALENDAR_PERIOD_UNSPECIFIED = 0

  Undefined period, raises an error.

• DAY = 1

  A day.

• WEEK = 2

  A week. Weeks begin on Monday, following [ISO 8601](https://en.wikipedia.org/wiki/ISO_week_date).

• FORTNIGHT = 3

  A fortnight. The first calendar fortnight of the year begins at the start of week 1 according to [ISO 8601](https://en.wikipedia.org/wiki/ISO_week_date).

• MONTH = 4

  A month.

• QUARTER = 5

  A quarter. Quarters start on dates 1-Jan, 1-Apr, 1-Jul, and 1-Oct of each year.

• HALF = 6

  A half-year. Half-years start on dates 1-Jan and 1-Jul.

• YEAR = 7

  A year.

Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...

• float red = 1

  The amount of red in the color as a value in the interval [0, 1].

• float green = 2

  The amount of green in the color as a value in the interval [0, 1].

• float blue = 3

  The amount of blue in the color as a value in the interval [0, 1].

• optional protobuf.FloatValue alpha = 4

  The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0).

Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`.

Used in: events.firebase.firebasealerts.v1.CrashlyticsStabilityDigestPayload

• int32 year = 1

  Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.

• int32 month = 2

  Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.

• int32 day = 3

  Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.

Represents civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.

• int32 year = 1

  Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.

• int32 month = 2

  Required. Month of year. Must be from 1 to 12.

• int32 day = 3

  Required. Day of month. Must be from 1 to 31 and valid for the year and month.

• int32 hours = 4

  Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

• int32 minutes = 5

  Required. Minutes of hour of day. Must be from 0 to 59.

• int32 seconds = 6

  Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

• int32 nanos = 7

  Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

• oneof time_offset

  Optional. Specifies either the UTC offset or the time zone of the DateTime. Choose carefully between them, considering that time zone data may change in the future (for example, a country modifies their DST start/end dates, and future DateTimes in the affected range had already been stored). If omitted, the DateTime is considered to be in local time.

  • protobuf.Duration utc_offset = 8

    UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.

  • TimeZone time_zone = 9

    Time zone.

Represents a day of week.

Used in: events.cloud.alloydb.v1.AutomatedBackupPolicy.WeeklySchedule, events.cloud.memcache.v1.WeeklyMaintenanceWindow, events.cloud.metastore.v1.MaintenanceWindow, events.cloud.redis.v1.WeeklyMaintenanceWindow

• DAY_OF_WEEK_UNSPECIFIED = 0

  The unspecified day-of-week.

• MONDAY = 1

  The day-of-week of Monday.

• TUESDAY = 2

  The day-of-week of Tuesday.

• WEDNESDAY = 3

  The day-of-week of Wednesday.

• THURSDAY = 4

  The day-of-week of Thursday.

• FRIDAY = 5

  The day-of-week of Friday.

• SATURDAY = 6

  The day-of-week of Saturday.

• SUNDAY = 7

  The day-of-week of Sunday.

Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0"

• string expression = 1

  Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported.

• string title = 2

  An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

• string description = 3

  An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

• string location = 4

  An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

Represents a fraction in terms of a numerator divided by a denominator.

• int64 numerator = 1

  The portion of the denominator in the faction, e.g. 2 in 2/3.

• int64 denominator = 2

  The value by which the numerator is divided, e.g. 3 in 2/3. Must be positive.

An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges.

Used in: events.cloud.datastore.v1.Value, events.cloud.firestore.v1.Value

• double latitude = 1

  The latitude in degrees. It must be in the range [-90.0, +90.0].

• double longitude = 2

  The longitude in degrees. It must be in the range [-180.0, +180.0].

Represents an amount of money with its currency type.

• string currency_code = 1

  The 3-letter currency code defined in ISO 4217.

• int64 units = 2

  The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

• int32 nanos = 3

  Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Represents a month in the Gregorian calendar.

• MONTH_UNSPECIFIED = 0

  The unspecifed month.

• JANUARY = 1

  The month of January.

• FEBRUARY = 2

  The month of February.

• MARCH = 3

  The month of March.

• APRIL = 4

  The month of April.

• MAY = 5

  The month of May.

• JUNE = 6

  The month of June.

• JULY = 7

  The month of July.

• AUGUST = 8

  The month of August.

• SEPTEMBER = 9

  The month of September.

• OCTOBER = 10

  The month of October.

• NOVEMBER = 11

  The month of November.

• DECEMBER = 12

  The month of December.

Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478

• int32 revision = 1

  The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.

• string region_code = 2

  Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

• string language_code = 3

  Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

• string postal_code = 4

  Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

• string sorting_code = 5

  Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

• string administrative_area = 6

  Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

• string locality = 7

  Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

• string sublocality = 8

  Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

• repeated string address_lines = 9

  Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

• repeated string recipients = 10

  Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

• string organization = 11

  Optional. The name of the organization at the address.

A quaternion is defined as the quotient of two directed lines in a three-dimensional space or equivalently as the quotient of two Euclidean vectors (https://en.wikipedia.org/wiki/Quaternion). Quaternions are often used in calculations involving three-dimensional rotations (https://en.wikipedia.org/wiki/Quaternions_and_spatial_rotation), as they provide greater mathematical robustness by avoiding the gimbal lock problems that can be encountered when using Euler angles (https://en.wikipedia.org/wiki/Gimbal_lock). Quaternions are generally represented in this form: w + xi + yj + zk where x, y, z, and w are real numbers, and i, j, and k are three imaginary numbers. Our naming choice `(x, y, z, w)` comes from the desire to avoid confusion for those interested in the geometric properties of the quaternion in the 3D Cartesian space. Other texts often use alternative names or subscripts, such as `(a, b, c, d)`, `(1, i, j, k)`, or `(0, 1, 2, 3)`, which are perhaps better suited for mathematical interpretations. To avoid any confusion, as well as to maintain compatibility with a large number of software libraries, the quaternions represented using the protocol buffer below *must* follow the Hamilton convention, which defines `ij = k` (i.e. a right-handed algebra), and therefore: i^2 = j^2 = k^2 = ijk = −1 ij = −ji = k jk = −kj = i ki = −ik = j Please DO NOT use this to represent quaternions that follow the JPL convention, or any of the other quaternion flavors out there. Definitions: - Quaternion norm (or magnitude): `sqrt(x^2 + y^2 + z^2 + w^2)`. - Unit (or normalized) quaternion: a quaternion whose norm is 1. - Pure quaternion: a quaternion whose scalar component (`w`) is 0. - Rotation quaternion: a unit quaternion used to represent rotation. - Orientation quaternion: a unit quaternion used to represent orientation. A quaternion can be normalized by dividing it by its norm. The resulting quaternion maintains the same direction, but has a norm of 1, i.e. it moves on the unit sphere. This is generally necessary for rotation and orientation quaternions, to avoid rounding errors: https://en.wikipedia.org/wiki/Rotation_formalisms_in_three_dimensions Note that `(x, y, z, w)` and `(-x, -y, -z, -w)` represent the same rotation, but normalization would be even more useful, e.g. for comparison purposes, if it would produce a unique representation. It is thus recommended that `w` be kept positive, which can be achieved by changing all the signs when `w` is negative.

• double x = 1

  The x component.

• double y = 2

  The y component.

• double z = 3

  The z component.

• double w = 4

  The scalar component.

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and `google.protobuf.Timestamp`.

Used in: events.cloud.alloydb.v1.AutomatedBackupPolicy.WeeklySchedule, events.cloud.memcache.v1.WeeklyMaintenanceWindow, events.cloud.redis.v1.WeeklyMaintenanceWindow

• int32 hours = 1

  Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

• int32 minutes = 2

  Minutes of hour of day. Must be from 0 to 59.

• int32 seconds = 3

  Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

• int32 nanos = 4

  Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).

Used in: DateTime

• string id = 1

  IANA Time Zone Database time zone, e.g. "America/New_York".

• string version = 2

  Optional. IANA Time Zone Database version number, e.g. "2019a".