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

Commit

Permalink
docs: display resource name patterns in code font. (#125)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
yoshi-automation committed Apr 10, 2020
1 parent 0aba58d commit acc4ab7
Show file tree
Hide file tree
Showing 65 changed files with 335 additions and 335 deletions.
Expand Up @@ -241,7 +241,7 @@ public final ListClustersResponse listClusters(String projectId, String zone) {
* </code></pre>
*
* @param parent The parent (project and location) where the clusters will be listed. Specified in
* the format 'projects/&#42;/locations/&#42;'. Location "-" matches all zones and all
* the format `projects/&#42;/locations/&#42;`. Location "-" matches all zones and all
* regions.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -338,7 +338,7 @@ public final Cluster getCluster(String projectId, String zone, String clusterId)
* </code></pre>
*
* @param name The name (project, location, cluster) of the cluster to retrieve. Specified in the
* format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
* format `projects/&#42;/locations/&#42;/clusters/&#42;`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Cluster getCluster(String name) {
Expand Down Expand Up @@ -457,7 +457,7 @@ public final Operation createCluster(String projectId, String zone, Cluster clus
* </code></pre>
*
* @param parent The parent (project and location) where the cluster will be created. Specified in
* the format 'projects/&#42;/locations/&#42;'.
* the format `projects/&#42;/locations/&#42;`.
* @param cluster Required. A [cluster
* resource](https://cloud.google.com/container-engine/reference/rest/v1/projects.zones.clusters)
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
Expand Down Expand Up @@ -589,7 +589,7 @@ public final Operation updateCluster(
* </code></pre>
*
* @param name The name (project, location, cluster) of the cluster to update. Specified in the
* format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
* format `projects/&#42;/locations/&#42;/clusters/&#42;`.
* @param update Required. A description of the update.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -796,7 +796,7 @@ public final Operation setLoggingService(
* </code></pre>
*
* @param name The name (project, location, cluster) of the cluster to set logging. Specified in
* the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
* the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
* @param loggingService Required. The logging service the cluster should use to write metrics.
* Currently available options:
* <p>&#42; "logging.googleapis.com" - the Google Cloud Logging service &#42; "none" - no
Expand Down Expand Up @@ -915,7 +915,7 @@ public final Operation setMonitoringService(
* </code></pre>
*
* @param name The name (project, location, cluster) of the cluster to set monitoring. Specified
* in the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
* in the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
* @param monitoringService Required. The monitoring service the cluster should use to write
* metrics. Currently available options:
* <p>&#42; "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with
Expand Down Expand Up @@ -1033,7 +1033,7 @@ public final Operation setAddonsConfig(
* </code></pre>
*
* @param name The name (project, location, cluster) of the cluster to set addons. Specified in
* the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
* the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
* @param addonsConfig Required. The desired configurations for the various addons available to
* run in the cluster.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
Expand Down Expand Up @@ -1148,7 +1148,7 @@ public final Operation setLocations(
* </code></pre>
*
* @param name The name (project, location, cluster) of the cluster to set locations. Specified in
* the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
* the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
* @param locations Required. The desired list of Google Compute Engine
* [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes
* should be located. Changing the locations a cluster is in will result in nodes being either
Expand Down Expand Up @@ -1268,7 +1268,7 @@ public final Operation updateMaster(
* </code></pre>
*
* @param name The name (project, location, cluster) of the cluster to update. Specified in the
* format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
* format `projects/&#42;/locations/&#42;/clusters/&#42;`.
* @param masterVersion Required. The Kubernetes version to change the master to.
* <p>Users may specify either explicit versions offered by Kubernetes Engine or version
* aliases, which have the following behavior:
Expand Down Expand Up @@ -1441,7 +1441,7 @@ public final Operation deleteCluster(String projectId, String zone, String clust
* </code></pre>
*
* @param name The name (project, location, cluster) of the cluster to delete. Specified in the
* format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
* format `projects/&#42;/locations/&#42;/clusters/&#42;`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Operation deleteCluster(String name) {
Expand Down Expand Up @@ -1691,7 +1691,7 @@ public final void cancelOperation(String projectId, String zone, String operatio
* </code></pre>
*
* @param name The name (project, location, operation id) of the operation to cancel. Specified in
* the format 'projects/&#42;/locations/&#42;/operations/&#42;'.
* the format `projects/&#42;/locations/&#42;/operations/&#42;`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void cancelOperation(String name) {
Expand Down Expand Up @@ -1780,7 +1780,7 @@ public final ServerConfig getServerConfig(String projectId, String zone) {
* </code></pre>
*
* @param name The name (project and location) of the server config to get, specified in the
* format 'projects/&#42;/locations/&#42;'.
* format `projects/&#42;/locations/&#42;`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ServerConfig getServerConfig(String name) {
Expand Down Expand Up @@ -1877,7 +1877,7 @@ public final ListNodePoolsResponse listNodePools(
* </code></pre>
*
* @param parent The parent (project, location, cluster id) where the node pools will be listed.
* Specified in the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
* Specified in the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListNodePoolsResponse listNodePools(String parent) {
Expand Down Expand Up @@ -1978,7 +1978,7 @@ public final NodePool getNodePool(
* </code></pre>
*
* @param name The name (project, location, cluster, node pool id) of the node pool to get.
* Specified in the format 'projects/&#42;/locations/&#42;/clusters/&#42;/nodePools/&#42;'.
* Specified in the format `projects/&#42;/locations/&#42;/clusters/&#42;/nodePools/&#42;`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final NodePool getNodePool(String name) {
Expand Down Expand Up @@ -2079,7 +2079,7 @@ public final Operation createNodePool(
* </code></pre>
*
* @param parent The parent (project, location, cluster id) where the node pool will be created.
* Specified in the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
* Specified in the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
* @param nodePool Required. The node pool to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -2188,7 +2188,7 @@ public final Operation deleteNodePool(
* </code></pre>
*
* @param name The name (project, location, cluster, node pool id) of the node pool to delete.
* Specified in the format 'projects/&#42;/locations/&#42;/clusters/&#42;/nodePools/&#42;'.
* Specified in the format `projects/&#42;/locations/&#42;/clusters/&#42;/nodePools/&#42;`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Operation deleteNodePool(String name) {
Expand Down Expand Up @@ -2292,7 +2292,7 @@ public final Operation rollbackNodePoolUpgrade(
*
* @param name The name (project, location, cluster, node pool id) of the node poll to rollback
* upgrade. Specified in the format
* 'projects/&#42;/locations/&#42;/clusters/&#42;/nodePools/&#42;'.
* `projects/&#42;/locations/&#42;/clusters/&#42;/nodePools/&#42;`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Operation rollbackNodePoolUpgrade(String name) {
Expand Down Expand Up @@ -2492,7 +2492,7 @@ public final Operation setLegacyAbac(
* </code></pre>
*
* @param name The name (project, location, cluster id) of the cluster to set legacy abac.
* Specified in the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
* Specified in the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
* @param enabled Required. Whether ABAC authorization will be enabled in the cluster.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -2596,7 +2596,7 @@ public final Operation startIPRotation(String projectId, String zone, String clu
* </code></pre>
*
* @param name The name (project, location, cluster id) of the cluster to start IP rotation.
* Specified in the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
* Specified in the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Operation startIPRotation(String name) {
Expand Down Expand Up @@ -2692,7 +2692,7 @@ public final Operation completeIPRotation(String projectId, String zone, String
* </code></pre>
*
* @param name The name (project, location, cluster id) of the cluster to complete IP rotation.
* Specified in the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
* Specified in the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Operation completeIPRotation(String name) {
Expand Down Expand Up @@ -2839,7 +2839,7 @@ public final Operation setNetworkPolicy(
* </code></pre>
*
* @param name The name (project, location, cluster id) of the cluster to set networking policy.
* Specified in the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
* Specified in the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
* @param networkPolicy Required. Configuration options for the NetworkPolicy feature.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -2946,7 +2946,7 @@ public final Operation setMaintenancePolicy(
* </code></pre>
*
* @param name The name (project, location, cluster id) of the cluster to set maintenance policy.
* Specified in the format 'projects/&#42;/locations/&#42;/clusters/&#42;'.
* Specified in the format `projects/&#42;/locations/&#42;/clusters/&#42;`.
* @param maintenancePolicy Required. The maintenance policy to be set for the cluster. An empty
* field clears the existing maintenance policy.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
Expand Down
Expand Up @@ -299,7 +299,7 @@ public com.google.protobuf.ByteString getOperationIdBytes() {
*
* <pre>
* The name (project, location, operation id) of the operation to cancel.
* Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;operations/&#42;'.
* Specified in the format `projects/&#42;&#47;locations/&#42;&#47;operations/&#42;`.
* </pre>
*
* <code>string name = 4;</code>
Expand All @@ -322,7 +322,7 @@ public java.lang.String getName() {
*
* <pre>
* The name (project, location, operation id) of the operation to cancel.
* Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;operations/&#42;'.
* Specified in the format `projects/&#42;&#47;locations/&#42;&#47;operations/&#42;`.
* </pre>
*
* <code>string name = 4;</code>
Expand Down Expand Up @@ -1069,7 +1069,7 @@ public Builder setOperationIdBytes(com.google.protobuf.ByteString value) {
*
* <pre>
* The name (project, location, operation id) of the operation to cancel.
* Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;operations/&#42;'.
* Specified in the format `projects/&#42;&#47;locations/&#42;&#47;operations/&#42;`.
* </pre>
*
* <code>string name = 4;</code>
Expand All @@ -1092,7 +1092,7 @@ public java.lang.String getName() {
*
* <pre>
* The name (project, location, operation id) of the operation to cancel.
* Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;operations/&#42;'.
* Specified in the format `projects/&#42;&#47;locations/&#42;&#47;operations/&#42;`.
* </pre>
*
* <code>string name = 4;</code>
Expand All @@ -1115,7 +1115,7 @@ public com.google.protobuf.ByteString getNameBytes() {
*
* <pre>
* The name (project, location, operation id) of the operation to cancel.
* Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;operations/&#42;'.
* Specified in the format `projects/&#42;&#47;locations/&#42;&#47;operations/&#42;`.
* </pre>
*
* <code>string name = 4;</code>
Expand All @@ -1137,7 +1137,7 @@ public Builder setName(java.lang.String value) {
*
* <pre>
* The name (project, location, operation id) of the operation to cancel.
* Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;operations/&#42;'.
* Specified in the format `projects/&#42;&#47;locations/&#42;&#47;operations/&#42;`.
* </pre>
*
* <code>string name = 4;</code>
Expand All @@ -1155,7 +1155,7 @@ public Builder clearName() {
*
* <pre>
* The name (project, location, operation id) of the operation to cancel.
* Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;operations/&#42;'.
* Specified in the format `projects/&#42;&#47;locations/&#42;&#47;operations/&#42;`.
* </pre>
*
* <code>string name = 4;</code>
Expand Down
Expand Up @@ -119,7 +119,7 @@ public interface CancelOperationRequestOrBuilder
*
* <pre>
* The name (project, location, operation id) of the operation to cancel.
* Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;operations/&#42;'.
* Specified in the format `projects/&#42;&#47;locations/&#42;&#47;operations/&#42;`.
* </pre>
*
* <code>string name = 4;</code>
Expand All @@ -132,7 +132,7 @@ public interface CancelOperationRequestOrBuilder
*
* <pre>
* The name (project, location, operation id) of the operation to cancel.
* Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;operations/&#42;'.
* Specified in the format `projects/&#42;&#47;locations/&#42;&#47;operations/&#42;`.
* </pre>
*
* <code>string name = 4;</code>
Expand Down
Expand Up @@ -301,7 +301,7 @@ public com.google.protobuf.ByteString getClusterIdBytes() {
*
* <pre>
* The name (project, location, cluster id) of the cluster to complete IP
* rotation. Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;'.
* rotation. Specified in the format `projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;`.
* </pre>
*
* <code>string name = 7;</code>
Expand All @@ -324,7 +324,7 @@ public java.lang.String getName() {
*
* <pre>
* The name (project, location, cluster id) of the cluster to complete IP
* rotation. Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;'.
* rotation. Specified in the format `projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;`.
* </pre>
*
* <code>string name = 7;</code>
Expand Down Expand Up @@ -1078,7 +1078,7 @@ public Builder setClusterIdBytes(com.google.protobuf.ByteString value) {
*
* <pre>
* The name (project, location, cluster id) of the cluster to complete IP
* rotation. Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;'.
* rotation. Specified in the format `projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;`.
* </pre>
*
* <code>string name = 7;</code>
Expand All @@ -1101,7 +1101,7 @@ public java.lang.String getName() {
*
* <pre>
* The name (project, location, cluster id) of the cluster to complete IP
* rotation. Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;'.
* rotation. Specified in the format `projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;`.
* </pre>
*
* <code>string name = 7;</code>
Expand All @@ -1124,7 +1124,7 @@ public com.google.protobuf.ByteString getNameBytes() {
*
* <pre>
* The name (project, location, cluster id) of the cluster to complete IP
* rotation. Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;'.
* rotation. Specified in the format `projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;`.
* </pre>
*
* <code>string name = 7;</code>
Expand All @@ -1146,7 +1146,7 @@ public Builder setName(java.lang.String value) {
*
* <pre>
* The name (project, location, cluster id) of the cluster to complete IP
* rotation. Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;'.
* rotation. Specified in the format `projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;`.
* </pre>
*
* <code>string name = 7;</code>
Expand All @@ -1164,7 +1164,7 @@ public Builder clearName() {
*
* <pre>
* The name (project, location, cluster id) of the cluster to complete IP
* rotation. Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;'.
* rotation. Specified in the format `projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;`.
* </pre>
*
* <code>string name = 7;</code>
Expand Down
Expand Up @@ -121,7 +121,7 @@ public interface CompleteIPRotationRequestOrBuilder
*
* <pre>
* The name (project, location, cluster id) of the cluster to complete IP
* rotation. Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;'.
* rotation. Specified in the format `projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;`.
* </pre>
*
* <code>string name = 7;</code>
Expand All @@ -134,7 +134,7 @@ public interface CompleteIPRotationRequestOrBuilder
*
* <pre>
* The name (project, location, cluster id) of the cluster to complete IP
* rotation. Specified in the format 'projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;'.
* rotation. Specified in the format `projects/&#42;&#47;locations/&#42;&#47;clusters/&#42;`.
* </pre>
*
* <code>string name = 7;</code>
Expand Down

0 comments on commit acc4ab7

Please sign in to comment.