This section describes a set of standard message field definitions that should be used when similar concepts are needed. This will ensure the same concept has the same name and semantics across different APIs.
| Name | Type | Description |
|---|---|---|
name |
string |
The name field should contain the relative resource name. |
parent |
string |
For resource definitions and List/Create requests, the parent field should contain the parent relative resource name. |
create_time |
Timestamp |
The creation timestamp of an entity. |
update_time |
Timestamp |
The last update timestamp of an entity. Note: update_time is updated when create/patch/delete operation is performed. |
delete_time |
Timestamp |
The deletion timestamp of an entity, only if it supports retention. |
expire_time |
Timestamp |
The expiration timestamp of an entity if it happens to expire. |
start_time |
Timestamp |
The timestamp marking the beginning of some time period. |
end_time |
Timestamp |
The timestamp marking the end of some time period or operation (regardless of its success). |
read_time |
Timestamp |
The timestamp at which a particular an entity should be read (if used in a request) or was read (if used in a response). |
time_zone |
string |
The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. |
region_code |
string |
The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see http://www.unicode.org/reports/tr35/#unicode_region_subtag. |
language_code |
string |
The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. |
mime_type |
string |
An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml. |
display_name |
string |
The display name of an entity. |
title |
string |
The official name of an entity, such as company name. It should be treated as the formal version of display_name. |
description |
string |
One or more paragraphs of text description of an entity. |
filter |
string |
The standard filter parameter for List methods. |
query |
string |
The same as filter if being applied to a search method (ie :search) |
page_token |
string |
The pagination token in the List request. |
page_size |
int32 |
The pagination size in the List request. |
total_size |
int32 |
The total count of items in the list irrespective of pagination. |
next_page_token |
string |
The next pagination token in the List response. It should be used as page_token for the following request. An empty value means no more result. |
order_by |
string |
Specifies the result ordering for List requests. |
request_id |
string |
A unique string id used for detecting duplicated requests. |
resume_token |
string |
An opaque token used for resuming a streaming request. |
labels |
map<string, string> |
Represents Cloud resource labels. |
deleted |
bool |
If a resource allows undelete behavior, it must have a deleted field indicating the resource is deleted. |
show_deleted |
bool |
If a resource allows undelete behavior, the corresponding List method must have a show_deleted field so client can discover the deleted resources. |
update_mask |
FieldMask |
It is used for Update request message for performing partial update on a resource. This mask is relative to the resource, not to the request message. |
validate_only |
bool |
If true, it indicates that the given request should only be validated, not executed. |
