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

Commit

Permalink
docs(regen): updated proto documentation (#74)
Browse files Browse the repository at this point in the history
  • Loading branch information
@yoshi-automation
yoshi-automation committed Feb 18, 2020
1 parent 6c01383 commit 96c73b1
Show file tree
Hide file tree
Showing 71 changed files with 1,327 additions and 1,238 deletions.
40 changes: 20 additions & 20 deletions ...oud-monitoring/src/main/java/com/google/cloud/monitoring/v3/AlertPolicyServiceClient.java
View file
Expand Up @@ -184,8 +184,8 @@ public AlertPolicyServiceStub getStub() {
* }
* </code></pre>
*
* @param name Required. The project whose alert policies are to be listed. The format is
* <p>projects/[PROJECT_ID]
* @param name Required. The project whose alert policies are to be listed. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]
* <p>Note that this field names the parent container in which the alerting policies to be
* listed are stored. To retrieve a single alerting policy by name, use the
* [GetAlertPolicy][google.monitoring.v3.AlertPolicyService.GetAlertPolicy] operation,
Expand Down Expand Up @@ -215,8 +215,8 @@ public final ListAlertPoliciesPagedResponse listAlertPolicies(ProjectName name)
* }
* </code></pre>
*
* @param name Required. The project whose alert policies are to be listed. The format is
* <p>projects/[PROJECT_ID]
* @param name Required. The project whose alert policies are to be listed. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]
* <p>Note that this field names the parent container in which the alerting policies to be
* listed are stored. To retrieve a single alerting policy by name, use the
* [GetAlertPolicy][google.monitoring.v3.AlertPolicyService.GetAlertPolicy] operation,
Expand Down Expand Up @@ -323,8 +323,8 @@ public final ListAlertPoliciesPagedResponse listAlertPolicies(ListAlertPoliciesR
* }
* </code></pre>
*
* @param name Required. The alerting policy to retrieve. The format is
* <p>projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
* @param name Required. The alerting policy to retrieve. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AlertPolicy getAlertPolicy(AlertPolicyName name) {
Expand All @@ -346,8 +346,8 @@ public final AlertPolicy getAlertPolicy(AlertPolicyName name) {
* }
* </code></pre>
*
* @param name Required. The alerting policy to retrieve. The format is
* <p>projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
* @param name Required. The alerting policy to retrieve. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AlertPolicy getAlertPolicy(String name) {
Expand Down Expand Up @@ -414,15 +414,15 @@ public final UnaryCallable<GetAlertPolicyRequest, AlertPolicy> getAlertPolicyCal
* }
* </code></pre>
*
* @param name Required. The project in which to create the alerting policy. The format is
* `projects/[PROJECT_ID]`.
* @param name Required. The project in which to create the alerting policy. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]
* <p>Note that this field names the parent container in which the alerting policy will be
* written, not the name of the created policy. The alerting policy that is returned will have
* a name that contains a normalized representation of this name as a prefix but adds a suffix
* of the form `/alertPolicies/[POLICY_ID]`, identifying the policy in the container.
* of the form `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the container.
* @param alertPolicy Required. The requested alerting policy. You should omit the `name` field in
* this policy. The name will be returned in the new policy, including a new [ALERT_POLICY_ID]
* value.
* this policy. The name will be returned in the new policy, including a new
* `[ALERT_POLICY_ID]` value.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AlertPolicy createAlertPolicy(ProjectName name, AlertPolicy alertPolicy) {
Expand All @@ -448,15 +448,15 @@ public final AlertPolicy createAlertPolicy(ProjectName name, AlertPolicy alertPo
* }
* </code></pre>
*
* @param name Required. The project in which to create the alerting policy. The format is
* `projects/[PROJECT_ID]`.
* @param name Required. The project in which to create the alerting policy. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]
* <p>Note that this field names the parent container in which the alerting policy will be
* written, not the name of the created policy. The alerting policy that is returned will have
* a name that contains a normalized representation of this name as a prefix but adds a suffix
* of the form `/alertPolicies/[POLICY_ID]`, identifying the policy in the container.
* of the form `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the container.
* @param alertPolicy Required. The requested alerting policy. You should omit the `name` field in
* this policy. The name will be returned in the new policy, including a new [ALERT_POLICY_ID]
* value.
* this policy. The name will be returned in the new policy, including a new
* `[ALERT_POLICY_ID]` value.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AlertPolicy createAlertPolicy(String name, AlertPolicy alertPolicy) {
Expand Down Expand Up @@ -528,7 +528,7 @@ public final UnaryCallable<CreateAlertPolicyRequest, AlertPolicy> createAlertPol
* </code></pre>
*
* @param name Required. The alerting policy to delete. The format is:
* <p>projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
* <p>projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
* <p>For more information, see [AlertPolicy][google.monitoring.v3.AlertPolicy].
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand All @@ -554,7 +554,7 @@ public final void deleteAlertPolicy(AlertPolicyName name) {
* </code></pre>
*
* @param name Required. The alerting policy to delete. The format is:
* <p>projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
* <p>projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
* <p>For more information, see [AlertPolicy][google.monitoring.v3.AlertPolicy].
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down
40 changes: 20 additions & 20 deletions google-cloud-monitoring/src/main/java/com/google/cloud/monitoring/v3/GroupServiceClient.java
View file
Expand Up @@ -187,8 +187,8 @@ public GroupServiceStub getStub() {
* }
* </code></pre>
*
* @param name Required. The project whose groups are to be listed. The format is
* `"projects/{project_id_or_number}"`.
* @param name Required. The project whose groups are to be listed. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListGroupsPagedResponse listGroups(ProjectName name) {
Expand All @@ -212,8 +212,8 @@ public final ListGroupsPagedResponse listGroups(ProjectName name) {
* }
* </code></pre>
*
* @param name Required. The project whose groups are to be listed. The format is
* `"projects/{project_id_or_number}"`.
* @param name Required. The project whose groups are to be listed. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListGroupsPagedResponse listGroups(String name) {
Expand Down Expand Up @@ -314,8 +314,8 @@ public final UnaryCallable<ListGroupsRequest, ListGroupsResponse> listGroupsCall
* }
* </code></pre>
*
* @param name Required. The group to retrieve. The format is
* `"projects/{project_id_or_number}/groups/{group_id}"`.
* @param name Required. The group to retrieve. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Group getGroup(GroupName name) {
Expand All @@ -337,8 +337,8 @@ public final Group getGroup(GroupName name) {
* }
* </code></pre>
*
* @param name Required. The group to retrieve. The format is
* `"projects/{project_id_or_number}/groups/{group_id}"`.
* @param name Required. The group to retrieve. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Group getGroup(String name) {
Expand Down Expand Up @@ -405,8 +405,8 @@ public final UnaryCallable<GetGroupRequest, Group> getGroupCallable() {
* }
* </code></pre>
*
* @param name Required. The project in which to create the group. The format is
* `"projects/{project_id_or_number}"`.
* @param name Required. The project in which to create the group. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]
* @param group Required. A group definition. It is an error to define the `name` field because
* the system assigns the name.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
Expand Down Expand Up @@ -434,8 +434,8 @@ public final Group createGroup(ProjectName name, Group group) {
* }
* </code></pre>
*
* @param name Required. The project in which to create the group. The format is
* `"projects/{project_id_or_number}"`.
* @param name Required. The project in which to create the group. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]
* @param group Required. A group definition. It is an error to define the `name` field because
* the system assigns the name.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
Expand Down Expand Up @@ -575,8 +575,8 @@ public final UnaryCallable<UpdateGroupRequest, Group> updateGroupCallable() {
* }
* </code></pre>
*
* @param name Required. The group to delete. The format is
* `"projects/{project_id_or_number}/groups/{group_id}"`.
* @param name Required. The group to delete. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteGroup(GroupName name) {
Expand All @@ -598,8 +598,8 @@ public final void deleteGroup(GroupName name) {
* }
* </code></pre>
*
* @param name Required. The group to delete. The format is
* `"projects/{project_id_or_number}/groups/{group_id}"`.
* @param name Required. The group to delete. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteGroup(String name) {
Expand Down Expand Up @@ -667,8 +667,8 @@ public final UnaryCallable<DeleteGroupRequest, Empty> deleteGroupCallable() {
* }
* </code></pre>
*
* @param name Required. The group whose members are listed. The format is
* `"projects/{project_id_or_number}/groups/{group_id}"`.
* @param name Required. The group whose members are listed. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListGroupMembersPagedResponse listGroupMembers(GroupName name) {
Expand All @@ -692,8 +692,8 @@ public final ListGroupMembersPagedResponse listGroupMembers(GroupName name) {
* }
* </code></pre>
*
* @param name Required. The group whose members are listed. The format is
* `"projects/{project_id_or_number}/groups/{group_id}"`.
* @param name Required. The group whose members are listed. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListGroupMembersPagedResponse listGroupMembers(String name) {
Expand Down

0 comments on commit 96c73b1

Please sign in to comment.