Skip to content

Commit f563b1d

Browse files
Google APIscopybara-github
authored andcommitted
docs: Properly format literal strings.
PiperOrigin-RevId: 313202929
1 parent 973c671 commit f563b1d

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

google/cloud/asset/v1/assets.proto

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ message TemporalAsset {
4848
Asset asset = 3;
4949
}
5050

51-
// A time window specified by its "start_time" and "end_time".
51+
// A time window specified by its `start_time` and `end_time`.
5252
message TimeWindow {
5353
// Start time of the time window (exclusive).
5454
google.protobuf.Timestamp start_time = 1;
@@ -70,14 +70,14 @@ message Asset {
7070
};
7171

7272
// The full name of the asset. For example:
73-
// "//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1"
73+
// `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`
7474
//
7575
// See [Resource
7676
// names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
7777
// for more information.
7878
string name = 1;
7979

80-
// The type of the asset. For example: "compute.googleapis.com/Disk"
80+
// The type of the asset. For example: `compute.googleapis.com/Disk`
8181
//
8282
// See [Supported asset
8383
// types](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
@@ -128,27 +128,27 @@ message Asset {
128128

129129
// A representation of a Google Cloud resource.
130130
message Resource {
131-
// The API version. For example: "v1"
131+
// The API version. For example: `v1`
132132
string version = 1;
133133

134134
// The URL of the discovery document containing the resource's JSON schema.
135135
// For example:
136-
// "https://www.googleapis.com/discovery/v1/apis/compute/v1/rest"
136+
// `https://www.googleapis.com/discovery/v1/apis/compute/v1/rest`
137137
//
138138
// This value is unspecified for resources that do not have an API based on a
139139
// discovery document, such as Cloud Bigtable.
140140
string discovery_document_uri = 2;
141141

142142
// The JSON schema name listed in the discovery document. For example:
143-
// "Project"
143+
// `Project`
144144
//
145145
// This value is unspecified for resources that do not have an API based on a
146146
// discovery document, such as Cloud Bigtable.
147147
string discovery_name = 3;
148148

149149
// The REST URL for accessing the resource. An HTTP `GET` request using this
150150
// URL returns the resource itself. For example:
151-
// "https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123"
151+
// `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`
152152
//
153153
// This value is unspecified for resources without a REST API.
154154
string resource_url = 4;
@@ -162,7 +162,7 @@ message Resource {
162162
// [Cloud IAM policy
163163
// hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy).
164164
// For example:
165-
// "//cloudresourcemanager.googleapis.com/projects/my_project_123"
165+
// `//cloudresourcemanager.googleapis.com/projects/my_project_123`
166166
//
167167
// For third-party assets, this field may be set differently.
168168
string parent = 5;
@@ -179,7 +179,7 @@ message Resource {
179179
// A result of Resource Search, containing information of a cloud resoure.
180180
message ResourceSearchResult {
181181
// The full resource name of this resource. Example:
182-
// "//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1".
182+
// `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
183183
// See [Cloud Asset Inventory Resource Name
184184
// Format](https://cloud.google.com/asset-inventory/docs/resource-name-format)
185185
// for more information.
@@ -190,7 +190,7 @@ message ResourceSearchResult {
190190
// * use a free text query. Example: `"instance1"`
191191
string name = 1;
192192

193-
// The type of this resource. Example: "compute.googleapis.com/Disk".
193+
// The type of this resource. Example: `compute.googleapis.com/Disk`.
194194
//
195195
// To search against the `asset_type`:
196196
//
@@ -222,8 +222,8 @@ message ResourceSearchResult {
222222
// * use a free text query. Example: `"*important instance*"`
223223
string description = 5;
224224

225-
// Location can be "global", regional like "us-east1", or zonal like
226-
// "us-west1-b".
225+
// Location can be `global`, regional like `us-east1`, or zonal like
226+
// `us-west1-b`.
227227
//
228228
// To search against the `location`:
229229
//
@@ -256,13 +256,13 @@ message ResourceSearchResult {
256256
repeated string network_tags = 8;
257257

258258
// The additional attributes of this resource. The attributes may vary from
259-
// one resource type to another. Examples: "projectId" for Project,
260-
// "dnsName" for DNS ManagedZone.
259+
// one resource type to another. Examples: `projectId` for Project,
260+
// `dnsName` for DNS ManagedZone.
261261
//
262262
// To search against the `additional_attributes`:
263263
//
264264
// * use a free text query to match the attributes values. Example: to search
265-
// additional_attributes = { dnsName: "foobar" }, you can issue a query
265+
// `additional_attributes = { dnsName: "foobar" }`, you can issue a query
266266
// `"foobar"`.
267267
google.protobuf.Struct additional_attributes = 9;
268268
}
@@ -273,23 +273,23 @@ message IamPolicySearchResult {
273273
message Explanation {
274274
// IAM permissions
275275
message Permissions {
276-
// A list of permissions. A sample permission string: "compute.disk.get".
276+
// A list of permissions. A sample permission string: `compute.disk.get`.
277277
repeated string permissions = 1;
278278
}
279279

280280
// The map from roles to their included permissions that match the
281281
// permission query (i.e., a query containing `policy.role.permissions:`).
282282
// Example: if query `policy.role.permissions : "compute.disk.get"`
283283
// matches a policy binding that contains owner role, the
284-
// matched_permissions will be {"roles/owner": ["compute.disk.get"]}. The
284+
// matched_permissions will be `{"roles/owner": ["compute.disk.get"]}`. The
285285
// roles can also be found in the returned `policy` bindings. Note that the
286286
// map is populated only for requests with permission queries.
287287
map<string, Permissions> matched_permissions = 1;
288288
}
289289

290290
// The full resource name of the resource associated with this IAM policy.
291291
// Example:
292-
// "//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1".
292+
// `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
293293
// See [Cloud Asset Inventory Resource Name
294294
// Format](https://cloud.google.com/asset-inventory/docs/resource-name-format)
295295
// for more information.

0 commit comments

Comments
 (0)