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

Commit 96c73b1

Browse files
yoshi-automationyoshi-automation
authored
docs(regen): updated proto documentation (#74)
1 parent 6c01383 commit 96c73b1

File tree

71 files changed

+1327
-1238
lines changed

Some content is hidden

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

71 files changed

+1327
-1238
lines changed

‎google-cloud-monitoring/src/main/java/com/google/cloud/monitoring/v3/AlertPolicyServiceClient.java

+20-20
Original file line numberDiff line numberDiff line change
@@ -184,8 +184,8 @@ public AlertPolicyServiceStub getStub() {
184184
* }
185185
* </code></pre>
186186
*
187-
* @param name Required. The project whose alert policies are to be listed. The format is
188-
* <p>projects/[PROJECT_ID]
187+
* @param name Required. The project whose alert policies are to be listed. The format is:
188+
* <p>projects/[PROJECT_ID_OR_NUMBER]
189189
* <p>Note that this field names the parent container in which the alerting policies to be
190190
* listed are stored. To retrieve a single alerting policy by name, use the
191191
* [GetAlertPolicy][google.monitoring.v3.AlertPolicyService.GetAlertPolicy] operation,
@@ -215,8 +215,8 @@ public final ListAlertPoliciesPagedResponse listAlertPolicies(ProjectName name)
215215
* }
216216
* </code></pre>
217217
*
218-
* @param name Required. The project whose alert policies are to be listed. The format is
219-
* <p>projects/[PROJECT_ID]
218+
* @param name Required. The project whose alert policies are to be listed. The format is:
219+
* <p>projects/[PROJECT_ID_OR_NUMBER]
220220
* <p>Note that this field names the parent container in which the alerting policies to be
221221
* listed are stored. To retrieve a single alerting policy by name, use the
222222
* [GetAlertPolicy][google.monitoring.v3.AlertPolicyService.GetAlertPolicy] operation,
@@ -323,8 +323,8 @@ public final ListAlertPoliciesPagedResponse listAlertPolicies(ListAlertPoliciesR
323323
* }
324324
* </code></pre>
325325
*
326-
* @param name Required. The alerting policy to retrieve. The format is
327-
* <p>projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
326+
* @param name Required. The alerting policy to retrieve. The format is:
327+
* <p>projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
328328
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
329329
*/
330330
public final AlertPolicy getAlertPolicy(AlertPolicyName name) {
@@ -346,8 +346,8 @@ public final AlertPolicy getAlertPolicy(AlertPolicyName name) {
346346
* }
347347
* </code></pre>
348348
*
349-
* @param name Required. The alerting policy to retrieve. The format is
350-
* <p>projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
349+
* @param name Required. The alerting policy to retrieve. The format is:
350+
* <p>projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
351351
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
352352
*/
353353
public final AlertPolicy getAlertPolicy(String name) {
@@ -414,15 +414,15 @@ public final UnaryCallable<GetAlertPolicyRequest, AlertPolicy> getAlertPolicyCal
414414
* }
415415
* </code></pre>
416416
*
417-
* @param name Required. The project in which to create the alerting policy. The format is
418-
* `projects/[PROJECT_ID]`.
417+
* @param name Required. The project in which to create the alerting policy. The format is:
418+
* <p>projects/[PROJECT_ID_OR_NUMBER]
419419
* <p>Note that this field names the parent container in which the alerting policy will be
420420
* written, not the name of the created policy. The alerting policy that is returned will have
421421
* a name that contains a normalized representation of this name as a prefix but adds a suffix
422-
* of the form `/alertPolicies/[POLICY_ID]`, identifying the policy in the container.
422+
* of the form `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the container.
423423
* @param alertPolicy Required. The requested alerting policy. You should omit the `name` field in
424-
* this policy. The name will be returned in the new policy, including a new [ALERT_POLICY_ID]
425-
* value.
424+
* this policy. The name will be returned in the new policy, including a new
425+
* `[ALERT_POLICY_ID]` value.
426426
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
427427
*/
428428
public final AlertPolicy createAlertPolicy(ProjectName name, AlertPolicy alertPolicy) {
@@ -448,15 +448,15 @@ public final AlertPolicy createAlertPolicy(ProjectName name, AlertPolicy alertPo
448448
* }
449449
* </code></pre>
450450
*
451-
* @param name Required. The project in which to create the alerting policy. The format is
452-
* `projects/[PROJECT_ID]`.
451+
* @param name Required. The project in which to create the alerting policy. The format is:
452+
* <p>projects/[PROJECT_ID_OR_NUMBER]
453453
* <p>Note that this field names the parent container in which the alerting policy will be
454454
* written, not the name of the created policy. The alerting policy that is returned will have
455455
* a name that contains a normalized representation of this name as a prefix but adds a suffix
456-
* of the form `/alertPolicies/[POLICY_ID]`, identifying the policy in the container.
456+
* of the form `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the container.
457457
* @param alertPolicy Required. The requested alerting policy. You should omit the `name` field in
458-
* this policy. The name will be returned in the new policy, including a new [ALERT_POLICY_ID]
459-
* value.
458+
* this policy. The name will be returned in the new policy, including a new
459+
* `[ALERT_POLICY_ID]` value.
460460
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
461461
*/
462462
public final AlertPolicy createAlertPolicy(String name, AlertPolicy alertPolicy) {
@@ -528,7 +528,7 @@ public final UnaryCallable<CreateAlertPolicyRequest, AlertPolicy> createAlertPol
528528
* </code></pre>
529529
*
530530
* @param name Required. The alerting policy to delete. The format is:
531-
* <p>projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
531+
* <p>projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
532532
* <p>For more information, see [AlertPolicy][google.monitoring.v3.AlertPolicy].
533533
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
534534
*/
@@ -554,7 +554,7 @@ public final void deleteAlertPolicy(AlertPolicyName name) {
554554
* </code></pre>
555555
*
556556
* @param name Required. The alerting policy to delete. The format is:
557-
* <p>projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
557+
* <p>projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
558558
* <p>For more information, see [AlertPolicy][google.monitoring.v3.AlertPolicy].
559559
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
560560
*/

‎google-cloud-monitoring/src/main/java/com/google/cloud/monitoring/v3/GroupServiceClient.java

+20-20
Original file line numberDiff line numberDiff line change
@@ -187,8 +187,8 @@ public GroupServiceStub getStub() {
187187
* }
188188
* </code></pre>
189189
*
190-
* @param name Required. The project whose groups are to be listed. The format is
191-
* `"projects/{project_id_or_number}"`.
190+
* @param name Required. The project whose groups are to be listed. The format is:
191+
* <p>projects/[PROJECT_ID_OR_NUMBER]
192192
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
193193
*/
194194
public final ListGroupsPagedResponse listGroups(ProjectName name) {
@@ -212,8 +212,8 @@ public final ListGroupsPagedResponse listGroups(ProjectName name) {
212212
* }
213213
* </code></pre>
214214
*
215-
* @param name Required. The project whose groups are to be listed. The format is
216-
* `"projects/{project_id_or_number}"`.
215+
* @param name Required. The project whose groups are to be listed. The format is:
216+
* <p>projects/[PROJECT_ID_OR_NUMBER]
217217
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
218218
*/
219219
public final ListGroupsPagedResponse listGroups(String name) {
@@ -314,8 +314,8 @@ public final UnaryCallable<ListGroupsRequest, ListGroupsResponse> listGroupsCall
314314
* }
315315
* </code></pre>
316316
*
317-
* @param name Required. The group to retrieve. The format is
318-
* `"projects/{project_id_or_number}/groups/{group_id}"`.
317+
* @param name Required. The group to retrieve. The format is:
318+
* <p>projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
319319
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
320320
*/
321321
public final Group getGroup(GroupName name) {
@@ -337,8 +337,8 @@ public final Group getGroup(GroupName name) {
337337
* }
338338
* </code></pre>
339339
*
340-
* @param name Required. The group to retrieve. The format is
341-
* `"projects/{project_id_or_number}/groups/{group_id}"`.
340+
* @param name Required. The group to retrieve. The format is:
341+
* <p>projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
342342
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
343343
*/
344344
public final Group getGroup(String name) {
@@ -405,8 +405,8 @@ public final UnaryCallable<GetGroupRequest, Group> getGroupCallable() {
405405
* }
406406
* </code></pre>
407407
*
408-
* @param name Required. The project in which to create the group. The format is
409-
* `"projects/{project_id_or_number}"`.
408+
* @param name Required. The project in which to create the group. The format is:
409+
* <p>projects/[PROJECT_ID_OR_NUMBER]
410410
* @param group Required. A group definition. It is an error to define the `name` field because
411411
* the system assigns the name.
412412
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -434,8 +434,8 @@ public final Group createGroup(ProjectName name, Group group) {
434434
* }
435435
* </code></pre>
436436
*
437-
* @param name Required. The project in which to create the group. The format is
438-
* `"projects/{project_id_or_number}"`.
437+
* @param name Required. The project in which to create the group. The format is:
438+
* <p>projects/[PROJECT_ID_OR_NUMBER]
439439
* @param group Required. A group definition. It is an error to define the `name` field because
440440
* the system assigns the name.
441441
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -575,8 +575,8 @@ public final UnaryCallable<UpdateGroupRequest, Group> updateGroupCallable() {
575575
* }
576576
* </code></pre>
577577
*
578-
* @param name Required. The group to delete. The format is
579-
* `"projects/{project_id_or_number}/groups/{group_id}"`.
578+
* @param name Required. The group to delete. The format is:
579+
* <p>projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
580580
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
581581
*/
582582
public final void deleteGroup(GroupName name) {
@@ -598,8 +598,8 @@ public final void deleteGroup(GroupName name) {
598598
* }
599599
* </code></pre>
600600
*
601-
* @param name Required. The group to delete. The format is
602-
* `"projects/{project_id_or_number}/groups/{group_id}"`.
601+
* @param name Required. The group to delete. The format is:
602+
* <p>projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
603603
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
604604
*/
605605
public final void deleteGroup(String name) {
@@ -667,8 +667,8 @@ public final UnaryCallable<DeleteGroupRequest, Empty> deleteGroupCallable() {
667667
* }
668668
* </code></pre>
669669
*
670-
* @param name Required. The group whose members are listed. The format is
671-
* `"projects/{project_id_or_number}/groups/{group_id}"`.
670+
* @param name Required. The group whose members are listed. The format is:
671+
* <p>projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
672672
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
673673
*/
674674
public final ListGroupMembersPagedResponse listGroupMembers(GroupName name) {
@@ -692,8 +692,8 @@ public final ListGroupMembersPagedResponse listGroupMembers(GroupName name) {
692692
* }
693693
* </code></pre>
694694
*
695-
* @param name Required. The group whose members are listed. The format is
696-
* `"projects/{project_id_or_number}/groups/{group_id}"`.
695+
* @param name Required. The group whose members are listed. The format is:
696+
* <p>projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
697697
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
698698
*/
699699
public final ListGroupMembersPagedResponse listGroupMembers(String name) {

0 commit comments

Comments
 (0)