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

Commit cd9330a

Browse files
yoshi-automationchingor13
yoshi-automation
authored and
chingor13
committed
docs(regen): updated required field documentation for v1beta1 client (#55)
1 parent 6f598ef commit cd9330a

12 files changed

Lines changed: 503 additions & 354 deletions

File tree

‎google-cloud-containeranalysis/src/main/java/com/google/cloud/devtools/containeranalysis/v1beta1/ContainerAnalysisV1Beta1Client.java‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -559,7 +559,7 @@ public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsReq
559559
* }
560560
* </code></pre>
561561
*
562-
* @param name The name of the scan configuration in the form of
562+
* @param name Required. The name of the scan configuration in the form of
563563
* `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
564564
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
565565
*/
@@ -582,7 +582,7 @@ public final ScanConfig getScanConfig(ScanConfigName name) {
582582
* }
583583
* </code></pre>
584584
*
585-
* @param name The name of the scan configuration in the form of
585+
* @param name Required. The name of the scan configuration in the form of
586586
* `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
587587
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
588588
*/
@@ -652,9 +652,9 @@ public final UnaryCallable<GetScanConfigRequest, ScanConfig> getScanConfigCallab
652652
* }
653653
* </code></pre>
654654
*
655-
* @param parent The name of the project to list scan configurations for in the form of
655+
* @param parent Required. The name of the project to list scan configurations for in the form of
656656
* `projects/[PROJECT_ID]`.
657-
* @param filter The filter expression.
657+
* @param filter Required. The filter expression.
658658
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
659659
*/
660660
public final ListScanConfigsPagedResponse listScanConfigs(ProjectName parent, String filter) {
@@ -682,9 +682,9 @@ public final ListScanConfigsPagedResponse listScanConfigs(ProjectName parent, St
682682
* }
683683
* </code></pre>
684684
*
685-
* @param parent The name of the project to list scan configurations for in the form of
685+
* @param parent Required. The name of the project to list scan configurations for in the form of
686686
* `projects/[PROJECT_ID]`.
687-
* @param filter The filter expression.
687+
* @param filter Required. The filter expression.
688688
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
689689
*/
690690
public final ListScanConfigsPagedResponse listScanConfigs(String parent, String filter) {
@@ -789,9 +789,9 @@ public final ListScanConfigsPagedResponse listScanConfigs(ListScanConfigsRequest
789789
* }
790790
* </code></pre>
791791
*
792-
* @param name The name of the scan configuration in the form of
792+
* @param name Required. The name of the scan configuration in the form of
793793
* `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
794-
* @param scanConfig The updated scan configuration.
794+
* @param scanConfig Required. The updated scan configuration.
795795
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
796796
*/
797797
public final ScanConfig updateScanConfig(ScanConfigName name, ScanConfig scanConfig) {
@@ -817,9 +817,9 @@ public final ScanConfig updateScanConfig(ScanConfigName name, ScanConfig scanCon
817817
* }
818818
* </code></pre>
819819
*
820-
* @param name The name of the scan configuration in the form of
820+
* @param name Required. The name of the scan configuration in the form of
821821
* `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
822-
* @param scanConfig The updated scan configuration.
822+
* @param scanConfig Required. The updated scan configuration.
823823
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
824824
*/
825825
public final ScanConfig updateScanConfig(String name, ScanConfig scanConfig) {

‎proto-google-cloud-containeranalysis-v1beta1/src/main/java/com/google/containeranalysis/v1beta1/Containeranalysis.java‎

Lines changed: 77 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -59,65 +59,81 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
5959
"\nAgoogle/devtools/containeranalysis/v1be"
6060
+ "ta1/containeranalysis.proto\022)google.devt"
6161
+ "ools.containeranalysis.v1beta1\032\034google/a"
62-
+ "pi/annotations.proto\032\036google/iam/v1/iam_"
63-
+ "policy.proto\032\032google/iam/v1/policy.proto"
64-
+ "\032\037google/protobuf/timestamp.proto\"\242\001\n\nSc"
65-
+ "anConfig\022\014\n\004name\030\001 \001(\t\022\023\n\013description\030\002 "
66-
+ "\001(\t\022\017\n\007enabled\030\003 \001(\010\022/\n\013create_time\030\004 \001("
67-
+ "\0132\032.google.protobuf.Timestamp\022/\n\013update_"
68-
+ "time\030\005 \001(\0132\032.google.protobuf.Timestamp\"$"
69-
+ "\n\024GetScanConfigRequest\022\014\n\004name\030\001 \001(\t\"_\n\026"
70-
+ "ListScanConfigsRequest\022\016\n\006parent\030\001 \001(\t\022\016"
71-
+ "\n\006filter\030\002 \001(\t\022\021\n\tpage_size\030\003 \001(\005\022\022\n\npag"
72-
+ "e_token\030\004 \001(\t\"\177\n\027ListScanConfigsResponse"
73-
+ "\022K\n\014scan_configs\030\001 \003(\01325.google.devtools"
74-
+ ".containeranalysis.v1beta1.ScanConfig\022\027\n"
75-
+ "\017next_page_token\030\002 \001(\t\"s\n\027UpdateScanConf"
76-
+ "igRequest\022\014\n\004name\030\001 \001(\t\022J\n\013scan_config\030\002"
77-
+ " \001(\01325.google.devtools.containeranalysis"
78-
+ ".v1beta1.ScanConfig2\204\n\n\030ContainerAnalysi"
79-
+ "sV1Beta1\022\311\001\n\014SetIamPolicy\022\".google.iam.v"
80-
+ "1.SetIamPolicyRequest\032\025.google.iam.v1.Po"
81-
+ "licy\"~\202\323\344\223\002x\"3/v1beta1/{resource=project"
82-
+ "s/*/notes/*}:setIamPolicy:\001*Z>\"9/v1beta1"
83-
+ "/{resource=projects/*/occurrences/*}:set"
84-
+ "IamPolicy:\001*\022\311\001\n\014GetIamPolicy\022\".google.i"
85-
+ "am.v1.GetIamPolicyRequest\032\025.google.iam.v"
86-
+ "1.Policy\"~\202\323\344\223\002x\"3/v1beta1/{resource=pro"
87-
+ "jects/*/notes/*}:getIamPolicy:\001*Z>\"9/v1b"
88-
+ "eta1/{resource=projects/*/occurrences/*}"
89-
+ ":getIamPolicy:\001*\022\367\001\n\022TestIamPermissions\022"
90-
+ "(.google.iam.v1.TestIamPermissionsReques"
91-
+ "t\032).google.iam.v1.TestIamPermissionsResp"
92-
+ "onse\"\213\001\202\323\344\223\002\204\001\"9/v1beta1/{resource=proje"
93-
+ "cts/*/notes/*}:testIamPermissions:\001*ZD\"?"
94-
+ "/v1beta1/{resource=projects/*/occurrence"
95-
+ "s/*}:testIamPermissions:\001*\022\271\001\n\rGetScanCo"
96-
+ "nfig\022?.google.devtools.containeranalysis"
97-
+ ".v1beta1.GetScanConfigRequest\0325.google.d"
98-
+ "evtools.containeranalysis.v1beta1.ScanCo"
99-
+ "nfig\"0\202\323\344\223\002*\022(/v1beta1/{name=projects/*/"
100-
+ "scanConfigs/*}\022\312\001\n\017ListScanConfigs\022A.goo"
62+
+ "pi/annotations.proto\032\027google/api/client."
63+
+ "proto\032\037google/api/field_behavior.proto\032\031"
64+
+ "google/api/resource.proto\032\036google/iam/v1"
65+
+ "/iam_policy.proto\032\032google/iam/v1/policy."
66+
+ "proto\032\037google/protobuf/timestamp.proto\"\202"
67+
+ "\002\n\nScanConfig\022\014\n\004name\030\001 \001(\t\022\023\n\013descripti"
68+
+ "on\030\002 \001(\t\022\017\n\007enabled\030\003 \001(\010\022/\n\013create_time"
69+
+ "\030\004 \001(\0132\032.google.protobuf.Timestamp\022/\n\013up"
70+
+ "date_time\030\005 \001(\0132\032.google.protobuf.Timest"
71+
+ "amp:^\352A[\n+containeranalysis.googleapis.c"
72+
+ "om/ScanConfig\022,projects/{project}/scanCo"
73+
+ "nfigs/{scan_config}\"Y\n\024GetScanConfigRequ"
74+
+ "est\022A\n\004name\030\001 \001(\tB3\340A\002\372A-\n+containeranal"
75+
+ "ysis.googleapis.com/ScanConfig\"\231\001\n\026ListS"
76+
+ "canConfigsRequest\022C\n\006parent\030\001 \001(\tB3\340A\002\372A"
77+
+ "-\n+cloudresourcemanager.googleapis.com/P"
78+
+ "roject\022\023\n\006filter\030\002 \001(\tB\003\340A\002\022\021\n\tpage_size"
79+
+ "\030\003 \001(\005\022\022\n\npage_token\030\004 \001(\t\"\177\n\027ListScanCo"
80+
+ "nfigsResponse\022K\n\014scan_configs\030\001 \003(\01325.go"
81+
+ "ogle.devtools.containeranalysis.v1beta1."
82+
+ "ScanConfig\022\027\n\017next_page_token\030\002 \001(\t\"\255\001\n\027"
83+
+ "UpdateScanConfigRequest\022A\n\004name\030\001 \001(\tB3\340"
84+
+ "A\002\372A-\n+containeranalysis.googleapis.com/"
85+
+ "ScanConfig\022O\n\013scan_config\030\002 \001(\01325.google"
86+
+ ".devtools.containeranalysis.v1beta1.Scan"
87+
+ "ConfigB\003\340A\0022\272\013\n\030ContainerAnalysisV1Beta1"
88+
+ "\022\334\001\n\014SetIamPolicy\022\".google.iam.v1.SetIam"
89+
+ "PolicyRequest\032\025.google.iam.v1.Policy\"\220\001\202"
90+
+ "\323\344\223\002x\"3/v1beta1/{resource=projects/*/not"
91+
+ "es/*}:setIamPolicy:\001*Z>\"9/v1beta1/{resou"
92+
+ "rce=projects/*/occurrences/*}:setIamPoli"
93+
+ "cy:\001*\332A\017resource,policy\022\325\001\n\014GetIamPolicy"
94+
+ "\022\".google.iam.v1.GetIamPolicyRequest\032\025.g"
95+
+ "oogle.iam.v1.Policy\"\211\001\202\323\344\223\002x\"3/v1beta1/{"
96+
+ "resource=projects/*/notes/*}:getIamPolic"
97+
+ "y:\001*Z>\"9/v1beta1/{resource=projects/*/oc"
98+
+ "currences/*}:getIamPolicy:\001*\332A\010resource\022"
99+
+ "\216\002\n\022TestIamPermissions\022(.google.iam.v1.T"
100+
+ "estIamPermissionsRequest\032).google.iam.v1"
101+
+ ".TestIamPermissionsResponse\"\242\001\202\323\344\223\002\204\001\"9/"
102+
+ "v1beta1/{resource=projects/*/notes/*}:te"
103+
+ "stIamPermissions:\001*ZD\"?/v1beta1/{resourc"
104+
+ "e=projects/*/occurrences/*}:testIamPermi"
105+
+ "ssions:\001*\332A\024resource,permissions\022\300\001\n\rGet"
106+
+ "ScanConfig\022?.google.devtools.containeran"
107+
+ "alysis.v1beta1.GetScanConfigRequest\0325.go"
108+
+ "ogle.devtools.containeranalysis.v1beta1."
109+
+ "ScanConfig\"7\202\323\344\223\002*\022(/v1beta1/{name=proje"
110+
+ "cts/*/scanConfigs/*}\332A\004name\022\332\001\n\017ListScan"
111+
+ "Configs\022A.google.devtools.containeranaly"
112+
+ "sis.v1beta1.ListScanConfigsRequest\032B.goo"
101113
+ "gle.devtools.containeranalysis.v1beta1.L"
102-
+ "istScanConfigsRequest\032B.google.devtools."
103-
+ "containeranalysis.v1beta1.ListScanConfig"
104-
+ "sResponse\"0\202\323\344\223\002*\022(/v1beta1/{parent=proj"
105-
+ "ects/*}/scanConfigs\022\314\001\n\020UpdateScanConfig"
106-
+ "\022B.google.devtools.containeranalysis.v1b"
107-
+ "eta1.UpdateScanConfigRequest\0325.google.de"
108-
+ "vtools.containeranalysis.v1beta1.ScanCon"
109-
+ "fig\"=\202\323\344\223\0027\032(/v1beta1/{name=projects/*/s"
110-
+ "canConfigs/*}:\013scan_configB\212\001\n$com.googl"
111-
+ "e.containeranalysis.v1beta1P\001ZZgoogle.go"
112-
+ "lang.org/genproto/googleapis/devtools/co"
113-
+ "ntaineranalysis/v1beta1;containeranalysi"
114-
+ "s\242\002\003GCAb\006proto3"
114+
+ "istScanConfigsResponse\"@\202\323\344\223\002*\022(/v1beta1"
115+
+ "/{parent=projects/*}/scanConfigs\332A\rparen"
116+
+ "t,filter\022\337\001\n\020UpdateScanConfig\022B.google.d"
117+
+ "evtools.containeranalysis.v1beta1.Update"
118+
+ "ScanConfigRequest\0325.google.devtools.cont"
119+
+ "aineranalysis.v1beta1.ScanConfig\"P\202\323\344\223\0027"
120+
+ "\032(/v1beta1/{name=projects/*/scanConfigs/"
121+
+ "*}:\013scan_config\332A\020name,scan_config\032T\312A c"
122+
+ "ontaineranalysis.googleapis.com\322A.https:"
123+
+ "//www.googleapis.com/auth/cloud-platform"
124+
+ "B\212\001\n$com.google.containeranalysis.v1beta"
125+
+ "1P\001ZZgoogle.golang.org/genproto/googleap"
126+
+ "is/devtools/containeranalysis/v1beta1;co"
127+
+ "ntaineranalysis\242\002\003GCAb\006proto3"
115128
};
116129
descriptor =
117130
com.google.protobuf.Descriptors.FileDescriptor.internalBuildGeneratedFileFrom(
118131
descriptorData,
119132
new com.google.protobuf.Descriptors.FileDescriptor[] {
120133
com.google.api.AnnotationsProto.getDescriptor(),
134+
com.google.api.ClientProto.getDescriptor(),
135+
com.google.api.FieldBehaviorProto.getDescriptor(),
136+
com.google.api.ResourceProto.getDescriptor(),
121137
com.google.iam.v1.IamPolicyProto.getDescriptor(),
122138
com.google.iam.v1.PolicyProto.getDescriptor(),
123139
com.google.protobuf.TimestampProto.getDescriptor(),
@@ -164,10 +180,19 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
164180
});
165181
com.google.protobuf.ExtensionRegistry registry =
166182
com.google.protobuf.ExtensionRegistry.newInstance();
183+
registry.add(com.google.api.ClientProto.defaultHost);
184+
registry.add(com.google.api.FieldBehaviorProto.fieldBehavior);
167185
registry.add(com.google.api.AnnotationsProto.http);
186+
registry.add(com.google.api.ClientProto.methodSignature);
187+
registry.add(com.google.api.ClientProto.oauthScopes);
188+
registry.add(com.google.api.ResourceProto.resource);
189+
registry.add(com.google.api.ResourceProto.resourceReference);
168190
com.google.protobuf.Descriptors.FileDescriptor.internalUpdateFileDescriptor(
169191
descriptor, registry);
170192
com.google.api.AnnotationsProto.getDescriptor();
193+
com.google.api.ClientProto.getDescriptor();
194+
com.google.api.FieldBehaviorProto.getDescriptor();
195+
com.google.api.ResourceProto.getDescriptor();
171196
com.google.iam.v1.IamPolicyProto.getDescriptor();
172197
com.google.iam.v1.PolicyProto.getDescriptor();
173198
com.google.protobuf.TimestampProto.getDescriptor();

‎proto-google-cloud-containeranalysis-v1beta1/src/main/java/com/google/containeranalysis/v1beta1/GetScanConfigRequest.java‎

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -117,11 +117,13 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
117117
*
118118
*
119119
* <pre>
120-
* The name of the scan configuration in the form of
120+
* Required. The name of the scan configuration in the form of
121121
* `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
122122
* </pre>
123123
*
124-
* <code>string name = 1;</code>
124+
* <code>
125+
* string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
126+
* </code>
125127
*
126128
* @return The name.
127129
*/
@@ -140,11 +142,13 @@ public java.lang.String getName() {
140142
*
141143
*
142144
* <pre>
143-
* The name of the scan configuration in the form of
145+
* Required. The name of the scan configuration in the form of
144146
* `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
145147
* </pre>
146148
*
147-
* <code>string name = 1;</code>
149+
* <code>
150+
* string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
151+
* </code>
148152
*
149153
* @return The bytes for name.
150154
*/
@@ -484,11 +488,13 @@ public Builder mergeFrom(
484488
*
485489
*
486490
* <pre>
487-
* The name of the scan configuration in the form of
491+
* Required. The name of the scan configuration in the form of
488492
* `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
489493
* </pre>
490494
*
491-
* <code>string name = 1;</code>
495+
* <code>
496+
* string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
497+
* </code>
492498
*
493499
* @return The name.
494500
*/
@@ -507,11 +513,13 @@ public java.lang.String getName() {
507513
*
508514
*
509515
* <pre>
510-
* The name of the scan configuration in the form of
516+
* Required. The name of the scan configuration in the form of
511517
* `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
512518
* </pre>
513519
*
514-
* <code>string name = 1;</code>
520+
* <code>
521+
* string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
522+
* </code>
515523
*
516524
* @return The bytes for name.
517525
*/
@@ -530,11 +538,13 @@ public com.google.protobuf.ByteString getNameBytes() {
530538
*
531539
*
532540
* <pre>
533-
* The name of the scan configuration in the form of
541+
* Required. The name of the scan configuration in the form of
534542
* `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
535543
* </pre>
536544
*
537-
* <code>string name = 1;</code>
545+
* <code>
546+
* string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
547+
* </code>
538548
*
539549
* @param value The name to set.
540550
* @return This builder for chaining.
@@ -552,11 +562,13 @@ public Builder setName(java.lang.String value) {
552562
*
553563
*
554564
* <pre>
555-
* The name of the scan configuration in the form of
565+
* Required. The name of the scan configuration in the form of
556566
* `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
557567
* </pre>
558568
*
559-
* <code>string name = 1;</code>
569+
* <code>
570+
* string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
571+
* </code>
560572
*
561573
* @return This builder for chaining.
562574
*/
@@ -570,11 +582,13 @@ public Builder clearName() {
570582
*
571583
*
572584
* <pre>
573-
* The name of the scan configuration in the form of
585+
* Required. The name of the scan configuration in the form of
574586
* `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
575587
* </pre>
576588
*
577-
* <code>string name = 1;</code>
589+
* <code>
590+
* string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
591+
* </code>
578592
*
579593
* @param value The bytes for name to set.
580594
* @return This builder for chaining.

‎proto-google-cloud-containeranalysis-v1beta1/src/main/java/com/google/containeranalysis/v1beta1/GetScanConfigRequestOrBuilder.java‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,13 @@ public interface GetScanConfigRequestOrBuilder
2727
*
2828
*
2929
* <pre>
30-
* The name of the scan configuration in the form of
30+
* Required. The name of the scan configuration in the form of
3131
* `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
3232
* </pre>
3333
*
34-
* <code>string name = 1;</code>
34+
* <code>
35+
* string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
36+
* </code>
3537
*
3638
* @return The name.
3739
*/
@@ -40,11 +42,13 @@ public interface GetScanConfigRequestOrBuilder
4042
*
4143
*
4244
* <pre>
43-
* The name of the scan configuration in the form of
45+
* Required. The name of the scan configuration in the form of
4446
* `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
4547
* </pre>
4648
*
47-
* <code>string name = 1;</code>
49+
* <code>
50+
* string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
51+
* </code>
4852
*
4953
* @return The bytes for name.
5054
*/

0 commit comments

Comments
 (0)