Skip to content
This repository was archived by the owner on Sep 16, 2023. It is now read-only.

Commit acc4ab7

Browse files
yoshi-automationyoshi-automation
authored
docs: display resource name patterns in code font. (#125)
Source-Repo: googleapis/googleapis Source-Sha: 9af7212bc2cba8a7184f032e1ab6662ccf604b3a Source-Link: googleapis/googleapis@9af7212 Author: Google APIs <noreply@google.com> Date: Thu Apr 9 13:42:02 2020 -0700 Original-Commit-Message: docs: display resource name patterns in code font. PiperOrigin-RevId: 305751417
1 parent 0aba58d commit acc4ab7

File tree

65 files changed

+335
-335
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+335
-335
lines changed

‎google-cloud-container/src/main/java/com/google/cloud/container/v1/ClusterManagerClient.java

+22-22
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ public final ListClustersResponse listClusters(String projectId, String zone) {
241241
* </code></pre>
242242
*
243243
* @param parent The parent (project and location) where the clusters will be listed. Specified in
244-
* the format 'projects/&#42;/locations/&#42;'. Location "-" matches all zones and all
244+
* the format `projects/&#42;/locations/&#42;`. Location "-" matches all zones and all
245245
* regions.
246246
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
247247
*/
@@ -338,7 +338,7 @@ public final Cluster getCluster(String projectId, String zone, String clusterId)
338338
* </code></pre>
339339
*
340340
* @param name The name (project, location, cluster) of the cluster to retrieve. Specified in the
341-
* format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
341+
* format `projects/&#42;/locations/&#42;/clusters/&#42;`.
342342
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
343343
*/
344344
public final Cluster getCluster(String name) {
@@ -457,7 +457,7 @@ public final Operation createCluster(String projectId, String zone, Cluster clus
457457
* </code></pre>
458458
*
459459
* @param parent The parent (project and location) where the cluster will be created. Specified in
460-
* the format 'projects/&#42;/locations/&#42;'.
460+
* the format `projects/&#42;/locations/&#42;`.
461461
* @param cluster Required. A [cluster
462462
* resource](https://cloud.google.com/container-engine/reference/rest/v1/projects.zones.clusters)
463463
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -589,7 +589,7 @@ public final Operation updateCluster(
589589
* </code></pre>
590590
*
591591
* @param name The name (project, location, cluster) of the cluster to update. Specified in the
592-
* format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
592+
* format `projects/&#42;/locations/&#42;/clusters/&#42;`.
593593
* @param update Required. A description of the update.
594594
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
595595
*/
@@ -796,7 +796,7 @@ public final Operation setLoggingService(
796796
* </code></pre>
797797
*
798798
* @param name The name (project, location, cluster) of the cluster to set logging. Specified in
799-
* the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
799+
* the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
800800
* @param loggingService Required. The logging service the cluster should use to write metrics.
801801
* Currently available options:
802802
* <p>&#42; "logging.googleapis.com" - the Google Cloud Logging service &#42; "none" - no
@@ -915,7 +915,7 @@ public final Operation setMonitoringService(
915915
* </code></pre>
916916
*
917917
* @param name The name (project, location, cluster) of the cluster to set monitoring. Specified
918-
* in the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
918+
* in the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
919919
* @param monitoringService Required. The monitoring service the cluster should use to write
920920
* metrics. Currently available options:
921921
* <p>&#42; "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with
@@ -1033,7 +1033,7 @@ public final Operation setAddonsConfig(
10331033
* </code></pre>
10341034
*
10351035
* @param name The name (project, location, cluster) of the cluster to set addons. Specified in
1036-
* the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
1036+
* the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
10371037
* @param addonsConfig Required. The desired configurations for the various addons available to
10381038
* run in the cluster.
10391039
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -1148,7 +1148,7 @@ public final Operation setLocations(
11481148
* </code></pre>
11491149
*
11501150
* @param name The name (project, location, cluster) of the cluster to set locations. Specified in
1151-
* the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
1151+
* the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
11521152
* @param locations Required. The desired list of Google Compute Engine
11531153
* [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes
11541154
* should be located. Changing the locations a cluster is in will result in nodes being either
@@ -1268,7 +1268,7 @@ public final Operation updateMaster(
12681268
* </code></pre>
12691269
*
12701270
* @param name The name (project, location, cluster) of the cluster to update. Specified in the
1271-
* format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
1271+
* format `projects/&#42;/locations/&#42;/clusters/&#42;`.
12721272
* @param masterVersion Required. The Kubernetes version to change the master to.
12731273
* <p>Users may specify either explicit versions offered by Kubernetes Engine or version
12741274
* aliases, which have the following behavior:
@@ -1441,7 +1441,7 @@ public final Operation deleteCluster(String projectId, String zone, String clust
14411441
* </code></pre>
14421442
*
14431443
* @param name The name (project, location, cluster) of the cluster to delete. Specified in the
1444-
* format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
1444+
* format `projects/&#42;/locations/&#42;/clusters/&#42;`.
14451445
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
14461446
*/
14471447
public final Operation deleteCluster(String name) {
@@ -1691,7 +1691,7 @@ public final void cancelOperation(String projectId, String zone, String operatio
16911691
* </code></pre>
16921692
*
16931693
* @param name The name (project, location, operation id) of the operation to cancel. Specified in
1694-
* the format 'projects/&#42;/locations/&#42;/operations/&#42;'.
1694+
* the format `projects/&#42;/locations/&#42;/operations/&#42;`.
16951695
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
16961696
*/
16971697
public final void cancelOperation(String name) {
@@ -1780,7 +1780,7 @@ public final ServerConfig getServerConfig(String projectId, String zone) {
17801780
* </code></pre>
17811781
*
17821782
* @param name The name (project and location) of the server config to get, specified in the
1783-
* format 'projects/&#42;/locations/&#42;'.
1783+
* format `projects/&#42;/locations/&#42;`.
17841784
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
17851785
*/
17861786
public final ServerConfig getServerConfig(String name) {
@@ -1877,7 +1877,7 @@ public final ListNodePoolsResponse listNodePools(
18771877
* </code></pre>
18781878
*
18791879
* @param parent The parent (project, location, cluster id) where the node pools will be listed.
1880-
* Specified in the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
1880+
* Specified in the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
18811881
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
18821882
*/
18831883
public final ListNodePoolsResponse listNodePools(String parent) {
@@ -1978,7 +1978,7 @@ public final NodePool getNodePool(
19781978
* </code></pre>
19791979
*
19801980
* @param name The name (project, location, cluster, node pool id) of the node pool to get.
1981-
* Specified in the format 'projects/&#42;/locations/&#42;/clusters/&#42;/nodePools/&#42;'.
1981+
* Specified in the format `projects/&#42;/locations/&#42;/clusters/&#42;/nodePools/&#42;`.
19821982
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
19831983
*/
19841984
public final NodePool getNodePool(String name) {
@@ -2079,7 +2079,7 @@ public final Operation createNodePool(
20792079
* </code></pre>
20802080
*
20812081
* @param parent The parent (project, location, cluster id) where the node pool will be created.
2082-
* Specified in the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
2082+
* Specified in the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
20832083
* @param nodePool Required. The node pool to create.
20842084
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
20852085
*/
@@ -2188,7 +2188,7 @@ public final Operation deleteNodePool(
21882188
* </code></pre>
21892189
*
21902190
* @param name The name (project, location, cluster, node pool id) of the node pool to delete.
2191-
* Specified in the format 'projects/&#42;/locations/&#42;/clusters/&#42;/nodePools/&#42;'.
2191+
* Specified in the format `projects/&#42;/locations/&#42;/clusters/&#42;/nodePools/&#42;`.
21922192
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
21932193
*/
21942194
public final Operation deleteNodePool(String name) {
@@ -2292,7 +2292,7 @@ public final Operation rollbackNodePoolUpgrade(
22922292
*
22932293
* @param name The name (project, location, cluster, node pool id) of the node poll to rollback
22942294
* upgrade. Specified in the format
2295-
* 'projects/&#42;/locations/&#42;/clusters/&#42;/nodePools/&#42;'.
2295+
* `projects/&#42;/locations/&#42;/clusters/&#42;/nodePools/&#42;`.
22962296
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
22972297
*/
22982298
public final Operation rollbackNodePoolUpgrade(String name) {
@@ -2492,7 +2492,7 @@ public final Operation setLegacyAbac(
24922492
* </code></pre>
24932493
*
24942494
* @param name The name (project, location, cluster id) of the cluster to set legacy abac.
2495-
* Specified in the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
2495+
* Specified in the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
24962496
* @param enabled Required. Whether ABAC authorization will be enabled in the cluster.
24972497
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
24982498
*/
@@ -2596,7 +2596,7 @@ public final Operation startIPRotation(String projectId, String zone, String clu
25962596
* </code></pre>
25972597
*
25982598
* @param name The name (project, location, cluster id) of the cluster to start IP rotation.
2599-
* Specified in the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
2599+
* Specified in the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
26002600
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
26012601
*/
26022602
public final Operation startIPRotation(String name) {
@@ -2692,7 +2692,7 @@ public final Operation completeIPRotation(String projectId, String zone, String
26922692
* </code></pre>
26932693
*
26942694
* @param name The name (project, location, cluster id) of the cluster to complete IP rotation.
2695-
* Specified in the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
2695+
* Specified in the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
26962696
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
26972697
*/
26982698
public final Operation completeIPRotation(String name) {
@@ -2839,7 +2839,7 @@ public final Operation setNetworkPolicy(
28392839
* </code></pre>
28402840
*
28412841
* @param name The name (project, location, cluster id) of the cluster to set networking policy.
2842-
* Specified in the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
2842+
* Specified in the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
28432843
* @param networkPolicy Required. Configuration options for the NetworkPolicy feature.
28442844
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
28452845
*/
@@ -2946,7 +2946,7 @@ public final Operation setMaintenancePolicy(
29462946
* </code></pre>
29472947
*
29482948
* @param name The name (project, location, cluster id) of the cluster to set maintenance policy.
2949-
* Specified in the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
2949+
* Specified in the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
29502950
* @param maintenancePolicy Required. The maintenance policy to be set for the cluster. An empty
29512951
* field clears the existing maintenance policy.
29522952
* @throws com.google.api.gax.rpc.ApiException if the remote call fails

‎proto-google-cloud-container-v1/src/main/java/com/google/container/v1/CancelOperationRequest.java

+7-7
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ public com.google.protobuf.ByteString getOperationIdBytes() {
299299
*
300300
* <pre>
301301
* The name (project, location, operation id) of the operation to cancel.
302-
* Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;operations/&#42;'.
302+
* Specified in the format `projects/&#42;&#47;locations/&#42;&#47;operations/&#42;`.
303303
* </pre>
304304
*
305305
* <code>string name = 4;</code>
@@ -322,7 +322,7 @@ public java.lang.String getName() {
322322
*
323323
* <pre>
324324
* The name (project, location, operation id) of the operation to cancel.
325-
* Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;operations/&#42;'.
325+
* Specified in the format `projects/&#42;&#47;locations/&#42;&#47;operations/&#42;`.
326326
* </pre>
327327
*
328328
* <code>string name = 4;</code>
@@ -1069,7 +1069,7 @@ public Builder setOperationIdBytes(com.google.protobuf.ByteString value) {
10691069
*
10701070
* <pre>
10711071
* The name (project, location, operation id) of the operation to cancel.
1072-
* Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;operations/&#42;'.
1072+
* Specified in the format `projects/&#42;&#47;locations/&#42;&#47;operations/&#42;`.
10731073
* </pre>
10741074
*
10751075
* <code>string name = 4;</code>
@@ -1092,7 +1092,7 @@ public java.lang.String getName() {
10921092
*
10931093
* <pre>
10941094
* The name (project, location, operation id) of the operation to cancel.
1095-
* Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;operations/&#42;'.
1095+
* Specified in the format `projects/&#42;&#47;locations/&#42;&#47;operations/&#42;`.
10961096
* </pre>
10971097
*
10981098
* <code>string name = 4;</code>
@@ -1115,7 +1115,7 @@ public com.google.protobuf.ByteString getNameBytes() {
11151115
*
11161116
* <pre>
11171117
* The name (project, location, operation id) of the operation to cancel.
1118-
* Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;operations/&#42;'.
1118+
* Specified in the format `projects/&#42;&#47;locations/&#42;&#47;operations/&#42;`.
11191119
* </pre>
11201120
*
11211121
* <code>string name = 4;</code>
@@ -1137,7 +1137,7 @@ public Builder setName(java.lang.String value) {
11371137
*
11381138
* <pre>
11391139
* The name (project, location, operation id) of the operation to cancel.
1140-
* Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;operations/&#42;'.
1140+
* Specified in the format `projects/&#42;&#47;locations/&#42;&#47;operations/&#42;`.
11411141
* </pre>
11421142
*
11431143
* <code>string name = 4;</code>
@@ -1155,7 +1155,7 @@ public Builder clearName() {
11551155
*
11561156
* <pre>
11571157
* The name (project, location, operation id) of the operation to cancel.
1158-
* Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;operations/&#42;'.
1158+
* Specified in the format `projects/&#42;&#47;locations/&#42;&#47;operations/&#42;`.
11591159
* </pre>
11601160
*
11611161
* <code>string name = 4;</code>

‎proto-google-cloud-container-v1/src/main/java/com/google/container/v1/CancelOperationRequestOrBuilder.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ public interface CancelOperationRequestOrBuilder
119119
*
120120
* <pre>
121121
* The name (project, location, operation id) of the operation to cancel.
122-
* Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;operations/&#42;'.
122+
* Specified in the format `projects/&#42;&#47;locations/&#42;&#47;operations/&#42;`.
123123
* </pre>
124124
*
125125
* <code>string name = 4;</code>
@@ -132,7 +132,7 @@ public interface CancelOperationRequestOrBuilder
132132
*
133133
* <pre>
134134
* The name (project, location, operation id) of the operation to cancel.
135-
* Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;operations/&#42;'.
135+
* Specified in the format `projects/&#42;&#47;locations/&#42;&#47;operations/&#42;`.
136136
* </pre>
137137
*
138138
* <code>string name = 4;</code>

‎proto-google-cloud-container-v1/src/main/java/com/google/container/v1/CompleteIPRotationRequest.java

+7-7
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ public com.google.protobuf.ByteString getClusterIdBytes() {
301301
*
302302
* <pre>
303303
* The name (project, location, cluster id) of the cluster to complete IP
304-
* rotation. Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;'.
304+
* rotation. Specified in the format `projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;`.
305305
* </pre>
306306
*
307307
* <code>string name = 7;</code>
@@ -324,7 +324,7 @@ public java.lang.String getName() {
324324
*
325325
* <pre>
326326
* The name (project, location, cluster id) of the cluster to complete IP
327-
* rotation. Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;'.
327+
* rotation. Specified in the format `projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;`.
328328
* </pre>
329329
*
330330
* <code>string name = 7;</code>
@@ -1078,7 +1078,7 @@ public Builder setClusterIdBytes(com.google.protobuf.ByteString value) {
10781078
*
10791079
* <pre>
10801080
* The name (project, location, cluster id) of the cluster to complete IP
1081-
* rotation. Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;'.
1081+
* rotation. Specified in the format `projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;`.
10821082
* </pre>
10831083
*
10841084
* <code>string name = 7;</code>
@@ -1101,7 +1101,7 @@ public java.lang.String getName() {
11011101
*
11021102
* <pre>
11031103
* The name (project, location, cluster id) of the cluster to complete IP
1104-
* rotation. Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;'.
1104+
* rotation. Specified in the format `projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;`.
11051105
* </pre>
11061106
*
11071107
* <code>string name = 7;</code>
@@ -1124,7 +1124,7 @@ public com.google.protobuf.ByteString getNameBytes() {
11241124
*
11251125
* <pre>
11261126
* The name (project, location, cluster id) of the cluster to complete IP
1127-
* rotation. Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;'.
1127+
* rotation. Specified in the format `projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;`.
11281128
* </pre>
11291129
*
11301130
* <code>string name = 7;</code>
@@ -1146,7 +1146,7 @@ public Builder setName(java.lang.String value) {
11461146
*
11471147
* <pre>
11481148
* The name (project, location, cluster id) of the cluster to complete IP
1149-
* rotation. Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;'.
1149+
* rotation. Specified in the format `projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;`.
11501150
* </pre>
11511151
*
11521152
* <code>string name = 7;</code>
@@ -1164,7 +1164,7 @@ public Builder clearName() {
11641164
*
11651165
* <pre>
11661166
* The name (project, location, cluster id) of the cluster to complete IP
1167-
* rotation. Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;'.
1167+
* rotation. Specified in the format `projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;`.
11681168
* </pre>
11691169
*
11701170
* <code>string name = 7;</code>

‎proto-google-cloud-container-v1/src/main/java/com/google/container/v1/CompleteIPRotationRequestOrBuilder.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ public interface CompleteIPRotationRequestOrBuilder
121121
*
122122
* <pre>
123123
* The name (project, location, cluster id) of the cluster to complete IP
124-
* rotation. Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;'.
124+
* rotation. Specified in the format `projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;`.
125125
* </pre>
126126
*
127127
* <code>string name = 7;</code>
@@ -134,7 +134,7 @@ public interface CompleteIPRotationRequestOrBuilder
134134
*
135135
* <pre>
136136
* The name (project, location, cluster id) of the cluster to complete IP
137-
* rotation. Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;'.
137+
* rotation. Specified in the format `projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;`.
138138
* </pre>
139139
*
140140
* <code>string name = 7;</code>

0 commit comments

Comments
 (0)