suguo
/
googleapis
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: display resource name patterns in code font. 

PiperOrigin-RevId: 305751417
This commit is contained in:
Google APIs 2020-04-09 13:42:02 -07:00 committed by Copybara-Service
parent c451a4457f
commit 9af7212bc2
2 changed files with 64 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
google/container/v1/cluster_service.proto
View File

@ -1461,7 +1461,7 @@ message CreateClusterRequest {
Cluster cluster = 3 [(google.api.field_behavior) = REQUIRED];
// The parent (project and location) where the cluster will be created.
// Specified in the format 'projects/*/locations/*'.
// Specified in the format `projects/*/locations/*`.
string parent = 5;
}
@ -1483,7 +1483,7 @@ message GetClusterRequest {
string cluster_id = 3 [deprecated = true];
// The name (project, location, cluster) of the cluster to retrieve.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 5;
}
@ -1508,7 +1508,7 @@ message UpdateClusterRequest {
ClusterUpdate update = 4 [(google.api.field_behavior) = REQUIRED];
// The name (project, location, cluster) of the cluster to update.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 5;
}
@ -1551,7 +1551,7 @@ message UpdateNodePoolRequest {
// The name (project, location, cluster, node pool) of the node pool to
// update. Specified in the format
// 'projects/*/locations/*/clusters/*/nodePools/*'.
// `projects/*/locations/*/clusters/*/nodePools/*`.
string name = 8;
}
@ -1581,7 +1581,7 @@ message SetNodePoolAutoscalingRequest {
// The name (project, location, cluster, node pool) of the node pool to set
// autoscaler settings. Specified in the format
// 'projects/*/locations/*/clusters/*/nodePools/*'.
// `projects/*/locations/*/clusters/*/nodePools/*`.
string name = 6;
}
@ -1610,7 +1610,7 @@ message SetLoggingServiceRequest {
string logging_service = 4 [(google.api.field_behavior) = REQUIRED];
// The name (project, location, cluster) of the cluster to set logging.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 5;
}
@ -1641,7 +1641,7 @@ message SetMonitoringServiceRequest {
string monitoring_service = 4 [(google.api.field_behavior) = REQUIRED];
// The name (project, location, cluster) of the cluster to set monitoring.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 6;
}
@ -1667,7 +1667,7 @@ message SetAddonsConfigRequest {
AddonsConfig addons_config = 4 [(google.api.field_behavior) = REQUIRED];
// The name (project, location, cluster) of the cluster to set addons.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 6;
}
@ -1698,7 +1698,7 @@ message SetLocationsRequest {
repeated string locations = 4 [(google.api.field_behavior) = REQUIRED];
// The name (project, location, cluster) of the cluster to set locations.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 6;
}
@ -1732,7 +1732,7 @@ message UpdateMasterRequest {
string master_version = 4 [(google.api.field_behavior) = REQUIRED];
// The name (project, location, cluster) of the cluster to update.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 7;
}
@ -1778,7 +1778,7 @@ message SetMasterAuthRequest {
MasterAuth update = 5 [(google.api.field_behavior) = REQUIRED];
// The name (project, location, cluster) of the cluster to set auth.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 7;
}
@ -1800,7 +1800,7 @@ message DeleteClusterRequest {
string cluster_id = 3 [deprecated = true];
// The name (project, location, cluster) of the cluster to delete.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 4;
}
@ -1818,7 +1818,7 @@ message ListClustersRequest {
string zone = 2 [deprecated = true];
// The parent (project and location) where the clusters will be listed.
// Specified in the format 'projects/*/locations/*'.
// Specified in the format `projects/*/locations/*`.
// Location "-" matches all zones and all regions.
string parent = 4;
}
@ -1852,7 +1852,7 @@ message GetOperationRequest {
string operation_id = 3 [deprecated = true];
// The name (project, location, operation id) of the operation to get.
// Specified in the format 'projects/*/locations/*/operations/*'.
// Specified in the format `projects/*/locations/*/operations/*`.
string name = 5;
}
@ -1869,7 +1869,7 @@ message ListOperationsRequest {
string zone = 2 [deprecated = true];
// The parent (project and location) where the operations will be listed.
// Specified in the format 'projects/*/locations/*'.
// Specified in the format `projects/*/locations/*`.
// Location "-" matches all zones and all regions.
string parent = 4;
}
@ -1891,7 +1891,7 @@ message CancelOperationRequest {
string operation_id = 3 [deprecated = true];
// The name (project, location, operation id) of the operation to cancel.
// Specified in the format 'projects/*/locations/*/operations/*'.
// Specified in the format `projects/*/locations/*/operations/*`.
string name = 4;
}
@ -1918,7 +1918,7 @@ message GetServerConfigRequest {
string zone = 2 [deprecated = true];
// The name (project and location) of the server config to get,
// specified in the format 'projects/*/locations/*'.
// specified in the format `projects/*/locations/*`.
string name = 4;
}
@ -1962,7 +1962,7 @@ message CreateNodePoolRequest {
// The parent (project, location, cluster id) where the node pool will be
// created. Specified in the format
// 'projects/*/locations/*/clusters/*'.
// `projects/*/locations/*/clusters/*`.
string parent = 6;
}
@ -1989,7 +1989,7 @@ message DeleteNodePoolRequest {
// The name (project, location, cluster, node pool id) of the node pool to
// delete. Specified in the format
// 'projects/*/locations/*/clusters/*/nodePools/*'.
// `projects/*/locations/*/clusters/*/nodePools/*`.
string name = 6;
}
@ -2011,7 +2011,7 @@ message ListNodePoolsRequest {
string cluster_id = 3 [deprecated = true];
// The parent (project, location, cluster id) where the node pools will be
// listed. Specified in the format 'projects/*/locations/*/clusters/*'.
// listed. Specified in the format `projects/*/locations/*/clusters/*`.
string parent = 5;
}
@ -2038,7 +2038,7 @@ message GetNodePoolRequest {
// The name (project, location, cluster, node pool id) of the node pool to
// get. Specified in the format
// 'projects/*/locations/*/clusters/*/nodePools/*'.
// `projects/*/locations/*/clusters/*/nodePools/*`.
string name = 6;
}
@ -2275,7 +2275,7 @@ message SetNodePoolManagementRequest {
// The name (project, location, cluster, node pool id) of the node pool to set
// management properties. Specified in the format
// 'projects/*/locations/*/clusters/*/nodePools/*'.
// `projects/*/locations/*/clusters/*/nodePools/*`.
string name = 7;
}
@ -2306,7 +2306,7 @@ message SetNodePoolSizeRequest {
// The name (project, location, cluster, node pool id) of the node pool to set
// size.
// Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.
// Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
string name = 7;
}
@ -2335,7 +2335,7 @@ message RollbackNodePoolUpgradeRequest {
// The name (project, location, cluster, node pool id) of the node poll to
// rollback upgrade.
// Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.
// Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
string name = 6;
}
@ -2440,7 +2440,7 @@ message SetLabelsRequest {
string label_fingerprint = 5 [(google.api.field_behavior) = REQUIRED];
// The name (project, location, cluster id) of the cluster to set labels.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 7;
}
@ -2466,7 +2466,7 @@ message SetLegacyAbacRequest {
bool enabled = 4 [(google.api.field_behavior) = REQUIRED];
// The name (project, location, cluster id) of the cluster to set legacy abac.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 6;
}
@ -2489,7 +2489,7 @@ message StartIPRotationRequest {
string cluster_id = 3 [deprecated = true];
// The name (project, location, cluster id) of the cluster to start IP
// rotation. Specified in the format 'projects/*/locations/*/clusters/*'.
// rotation. Specified in the format `projects/*/locations/*/clusters/*`.
string name = 6;
// Whether to rotate credentials during IP rotation.
@ -2514,7 +2514,7 @@ message CompleteIPRotationRequest {
string cluster_id = 3 [deprecated = true];
// The name (project, location, cluster id) of the cluster to complete IP
// rotation. Specified in the format 'projects/*/locations/*/clusters/*'.
// rotation. Specified in the format `projects/*/locations/*/clusters/*`.
string name = 7;
}
@ -2549,7 +2549,7 @@ message SetNetworkPolicyRequest {
NetworkPolicy network_policy = 4 [(google.api.field_behavior) = REQUIRED];
// The name (project, location, cluster id) of the cluster to set networking
// policy. Specified in the format 'projects/*/locations/*/clusters/*'.
// policy. Specified in the format `projects/*/locations/*/clusters/*`.
string name = 6;
}
@ -2573,7 +2573,7 @@ message SetMaintenancePolicyRequest {
// The name (project, location, cluster id) of the cluster to set maintenance
// policy.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 5;
}
@ -2669,7 +2669,7 @@ message DatabaseEncryption {
// available to a user for creating clusters.
message ListUsableSubnetworksRequest {
// The parent project where subnetworks are usable.
// Specified in the format 'projects/*'.
// Specified in the format `projects/*`.
string parent = 1;
// Filtering currently only supports equality on the networkProjectId and must

66
google/container/v1beta1/cluster_service.proto
View File

@ -1566,7 +1566,7 @@ message CreateClusterRequest {
Cluster cluster = 3 [(google.api.field_behavior) = REQUIRED];
// The parent (project and location) where the cluster will be created.
// Specified in the format 'projects/*/locations/*'.
// Specified in the format `projects/*/locations/*`.
string parent = 5;
}
@ -1597,7 +1597,7 @@ message GetClusterRequest {
];
// The name (project, location, cluster) of the cluster to retrieve.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 5;
}
@ -1631,7 +1631,7 @@ message UpdateClusterRequest {
ClusterUpdate update = 4 [(google.api.field_behavior) = REQUIRED];
// The name (project, location, cluster) of the cluster to update.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 5;
}
@ -1689,7 +1689,7 @@ message UpdateNodePoolRequest {
// The name (project, location, cluster, node pool) of the node pool to
// update. Specified in the format
// 'projects/*/locations/*/clusters/*/nodePools/*'.
// `projects/*/locations/*/clusters/*/nodePools/*`.
string name = 8;
}
@ -1731,7 +1731,7 @@ message SetNodePoolAutoscalingRequest {
// The name (project, location, cluster, node pool) of the node pool to set
// autoscaler settings. Specified in the format
// 'projects/*/locations/*/clusters/*/nodePools/*'.
// `projects/*/locations/*/clusters/*/nodePools/*`.
string name = 6;
}
@ -1769,7 +1769,7 @@ message SetLoggingServiceRequest {
string logging_service = 4 [(google.api.field_behavior) = REQUIRED];
// The name (project, location, cluster) of the cluster to set logging.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 5;
}
@ -1807,7 +1807,7 @@ message SetMonitoringServiceRequest {
string monitoring_service = 4 [(google.api.field_behavior) = REQUIRED];
// The name (project, location, cluster) of the cluster to set monitoring.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 6;
}
@ -1842,7 +1842,7 @@ message SetAddonsConfigRequest {
AddonsConfig addons_config = 4 [(google.api.field_behavior) = REQUIRED];
// The name (project, location, cluster) of the cluster to set addons.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 6;
}
@ -1882,7 +1882,7 @@ message SetLocationsRequest {
repeated string locations = 4 [(google.api.field_behavior) = REQUIRED];
// The name (project, location, cluster) of the cluster to set locations.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 6;
}
@ -1925,7 +1925,7 @@ message UpdateMasterRequest {
string master_version = 4 [(google.api.field_behavior) = REQUIRED];
// The name (project, location, cluster) of the cluster to update.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 7;
}
@ -1980,7 +1980,7 @@ message SetMasterAuthRequest {
MasterAuth update = 5 [(google.api.field_behavior) = REQUIRED];
// The name (project, location, cluster) of the cluster to set auth.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 7;
}
@ -2011,7 +2011,7 @@ message DeleteClusterRequest {
];
// The name (project, location, cluster) of the cluster to delete.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 4;
}
@ -2035,7 +2035,7 @@ message ListClustersRequest {
];
// The parent (project and location) where the clusters will be listed.
// Specified in the format 'projects/*/locations/*'.
// Specified in the format `projects/*/locations/*`.
// Location "-" matches all zones and all regions.
string parent = 4;
}
@ -2078,7 +2078,7 @@ message GetOperationRequest {
];
// The name (project, location, operation id) of the operation to get.
// Specified in the format 'projects/*/locations/*/operations/*'.
// Specified in the format `projects/*/locations/*/operations/*`.
string name = 5;
}
@ -2101,7 +2101,7 @@ message ListOperationsRequest {
];
// The parent (project and location) where the operations will be listed.
// Specified in the format 'projects/*/locations/*'.
// Specified in the format `projects/*/locations/*`.
// Location "-" matches all zones and all regions.
string parent = 4;
}
@ -2132,7 +2132,7 @@ message CancelOperationRequest {
];
// The name (project, location, operation id) of the operation to cancel.
// Specified in the format 'projects/*/locations/*/operations/*'.
// Specified in the format `projects/*/locations/*/operations/*`.
string name = 4;
}
@ -2165,7 +2165,7 @@ message GetServerConfigRequest {
];
// The name (project and location) of the server config to get,
// specified in the format 'projects/*/locations/*'.
// specified in the format `projects/*/locations/*`.
string name = 4;
}
@ -2218,7 +2218,7 @@ message CreateNodePoolRequest {
// The parent (project, location, cluster id) where the node pool will be
// created. Specified in the format
// 'projects/*/locations/*/clusters/*'.
// `projects/*/locations/*/clusters/*`.
string parent = 6;
}
@ -2257,7 +2257,7 @@ message DeleteNodePoolRequest {
// The name (project, location, cluster, node pool id) of the node pool to
// delete. Specified in the format
// 'projects/*/locations/*/clusters/*/nodePools/*'.
// `projects/*/locations/*/clusters/*/nodePools/*`.
string name = 6;
}
@ -2288,7 +2288,7 @@ message ListNodePoolsRequest {
];
// The parent (project, location, cluster id) where the node pools will be
// listed. Specified in the format 'projects/*/locations/*/clusters/*'.
// listed. Specified in the format `projects/*/locations/*/clusters/*`.
string parent = 5;
}
@ -2327,7 +2327,7 @@ message GetNodePoolRequest {
// The name (project, location, cluster, node pool id) of the node pool to
// get. Specified in the format
// 'projects/*/locations/*/clusters/*/nodePools/*'.
// `projects/*/locations/*/clusters/*/nodePools/*`.
string name = 6;
}
@ -2570,7 +2570,7 @@ message SetNodePoolManagementRequest {
// The name (project, location, cluster, node pool id) of the node pool to set
// management properties. Specified in the format
// 'projects/*/locations/*/clusters/*/nodePools/*'.
// `projects/*/locations/*/clusters/*/nodePools/*`.
string name = 7;
}
@ -2613,7 +2613,7 @@ message SetNodePoolSizeRequest {
// The name (project, location, cluster, node pool id) of the node pool to set
// size.
// Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.
// Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
string name = 7;
}
@ -2654,7 +2654,7 @@ message RollbackNodePoolUpgradeRequest {
// The name (project, location, cluster, node pool id) of the node poll to
// rollback upgrade.
// Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.
// Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
string name = 6;
}
@ -2768,7 +2768,7 @@ message SetLabelsRequest {
string label_fingerprint = 5 [(google.api.field_behavior) = REQUIRED];
// The name (project, location, cluster id) of the cluster to set labels.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 7;
}
@ -2803,7 +2803,7 @@ message SetLegacyAbacRequest {
bool enabled = 4 [(google.api.field_behavior) = REQUIRED];
// The name (project, location, cluster id) of the cluster to set legacy abac.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 6;
}
@ -2835,7 +2835,7 @@ message StartIPRotationRequest {
];
// The name (project, location, cluster id) of the cluster to start IP
// rotation. Specified in the format 'projects/*/locations/*/clusters/*'.
// rotation. Specified in the format `projects/*/locations/*/clusters/*`.
string name = 6;
// Whether to rotate credentials during IP rotation.
@ -2869,7 +2869,7 @@ message CompleteIPRotationRequest {
];
// The name (project, location, cluster id) of the cluster to complete IP
// rotation. Specified in the format 'projects/*/locations/*/clusters/*'.
// rotation. Specified in the format `projects/*/locations/*/clusters/*`.
string name = 7;
}
@ -2941,7 +2941,7 @@ message SetNetworkPolicyRequest {
NetworkPolicy network_policy = 4 [(google.api.field_behavior) = REQUIRED];
// The name (project, location, cluster id) of the cluster to set networking
// policy. Specified in the format 'projects/*/locations/*/clusters/*'.
// policy. Specified in the format `projects/*/locations/*/clusters/*`.
string name = 6;
}
@ -2965,14 +2965,14 @@ message SetMaintenancePolicyRequest {
// The name (project, location, cluster id) of the cluster to set maintenance
// policy.
// Specified in the format 'projects/*/locations/*/clusters/*'.
// Specified in the format `projects/*/locations/*/clusters/*`.
string name = 5;
}
// ListLocationsRequest is used to request the locations that offer GKE.
message ListLocationsRequest {
// Required. Contains the name of the resource requested.
// Specified in the format 'projects/*'.
// Specified in the format `projects/*`.
string parent = 1 [(google.api.field_behavior) = REQUIRED];
}
@ -3009,7 +3009,7 @@ message Location {
LocationType type = 1;
// Contains the name of the resource requested.
// Specified in the format 'projects/*/locations/*'.
// Specified in the format `projects/*/locations/*`.
string name = 2;
// Whether the location is recomended for GKE cluster scheduling.
@ -3072,7 +3072,7 @@ message NetworkConfig {
// available to a user for creating clusters.
message ListUsableSubnetworksRequest {
// Required. The parent project where subnetworks are usable.
// Specified in the format 'projects/*'.
// Specified in the format `projects/*`.
string parent = 1 [(google.api.field_behavior) = REQUIRED];
// Filtering currently only supports equality on the networkProjectId and must