Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: [securitycentermanagement] Clarify documentation for ListDescendantSecurityHealthAnalyticsCustomModules RPC and CostumConfig message #10443

Merged
merged 2 commits into from
Feb 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions java-securitycentermanagement/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>libraries-bom</artifactId>
<version>26.32.0</version>
<version>26.33.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down Expand Up @@ -201,7 +201,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-securitycentermanagement/java11.html
[stability-image]: https://img.shields.io/badge/stability-preview-yellow
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-securitycentermanagement.svg
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-securitycentermanagement/0.3.0
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-securitycentermanagement/0.4.0
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@
* </tr>
* <tr>
* <td><p> ListDescendantSecurityHealthAnalyticsCustomModules</td>
* <td><p> Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parents CRM descendants.</td>
* <td><p> Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent's CRM descendants.</td>
* <td>
* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
* <ul>
Expand Down Expand Up @@ -1309,7 +1309,7 @@ public SecurityCenterManagementStub getStub() {
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent
* and all of the parents CRM descendants.
* and all of the parent's CRM descendants.
*
* <p>Sample code:
*
Expand Down Expand Up @@ -1348,7 +1348,7 @@ public SecurityCenterManagementStub getStub() {
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent
* and all of the parents CRM descendants.
* and all of the parent's CRM descendants.
*
* <p>Sample code:
*
Expand Down Expand Up @@ -1387,7 +1387,7 @@ public SecurityCenterManagementStub getStub() {
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent
* and all of the parents CRM descendants.
* and all of the parent's CRM descendants.
*
* <p>Sample code:
*
Expand Down Expand Up @@ -1426,7 +1426,7 @@ public SecurityCenterManagementStub getStub() {
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent
* and all of the parents CRM descendants.
* and all of the parent's CRM descendants.
*
* <p>Sample code:
*
Expand Down Expand Up @@ -1465,7 +1465,7 @@ public SecurityCenterManagementStub getStub() {
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent
* and all of the parents CRM descendants.
* and all of the parent's CRM descendants.
*
* <p>Sample code:
*
Expand Down Expand Up @@ -1504,7 +1504,7 @@ public SecurityCenterManagementStub getStub() {
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent
* and all of the parents CRM descendants.
* and all of the parent's CRM descendants.
*
* <p>Sample code:
*
Expand Down Expand Up @@ -1543,7 +1543,7 @@ public SecurityCenterManagementStub getStub() {
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent
* and all of the parents CRM descendants.
* and all of the parent's CRM descendants.
*
* <p>Sample code:
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1324,7 +1324,7 @@ default void listSecurityHealthAnalyticsCustomModules(
*
* <pre>
* Returns a list of all resident SecurityHealthAnalyticsCustomModules under
* the given CRM parent and all of the parents CRM descendants.
* the given CRM parent and all of the parent's CRM descendants.
* </pre>
*/
default void listDescendantSecurityHealthAnalyticsCustomModules(
Expand Down Expand Up @@ -1729,7 +1729,7 @@ public void listSecurityHealthAnalyticsCustomModules(
*
* <pre>
* Returns a list of all resident SecurityHealthAnalyticsCustomModules under
* the given CRM parent and all of the parents CRM descendants.
* the given CRM parent and all of the parent's CRM descendants.
* </pre>
*/
public void listDescendantSecurityHealthAnalyticsCustomModules(
Expand Down Expand Up @@ -2152,7 +2152,7 @@ protected SecurityCenterManagementBlockingStub build(
*
* <pre>
* Returns a list of all resident SecurityHealthAnalyticsCustomModules under
* the given CRM parent and all of the parents CRM descendants.
* the given CRM parent and all of the parent's CRM descendants.
* </pre>
*/
public com.google.cloud.securitycentermanagement.v1
Expand Down Expand Up @@ -2556,7 +2556,7 @@ protected SecurityCenterManagementFutureStub build(
*
* <pre>
* Returns a list of all resident SecurityHealthAnalyticsCustomModules under
* the given CRM parent and all of the parents CRM descendants.
* the given CRM parent and all of the parent's CRM descendants.
* </pre>
*/
public com.google.common.util.concurrent.ListenableFuture<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3369,9 +3369,10 @@ public boolean hasCustomOutput() {
*
*
* <pre>
* Optional. The CAI resource types that the custom module operates on (see
* go/gcp-cai-doc/supported-asset-types). Each custom module can specify up to
* 5 resource types.
* Optional. The Cloud Asset Inventory resource types that the custom module
* operates on. For information about resource types, see [Supported asset
* types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
* Each custom module can specify up to 5 resource types.
* </pre>
*
* <code>
Expand All @@ -3388,9 +3389,10 @@ public boolean hasResourceSelector() {
*
*
* <pre>
* Optional. The CAI resource types that the custom module operates on (see
* go/gcp-cai-doc/supported-asset-types). Each custom module can specify up to
* 5 resource types.
* Optional. The Cloud Asset Inventory resource types that the custom module
* operates on. For information about resource types, see [Supported asset
* types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
* Each custom module can specify up to 5 resource types.
* </pre>
*
* <code>
Expand All @@ -3411,9 +3413,10 @@ public boolean hasResourceSelector() {
*
*
* <pre>
* Optional. The CAI resource types that the custom module operates on (see
* go/gcp-cai-doc/supported-asset-types). Each custom module can specify up to
* 5 resource types.
* Optional. The Cloud Asset Inventory resource types that the custom module
* operates on. For information about resource types, see [Supported asset
* types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
* Each custom module can specify up to 5 resource types.
* </pre>
*
* <code>
Expand Down Expand Up @@ -4502,9 +4505,10 @@ public Builder clearCustomOutput() {
*
*
* <pre>
* Optional. The CAI resource types that the custom module operates on (see
* go/gcp-cai-doc/supported-asset-types). Each custom module can specify up to
* 5 resource types.
* Optional. The Cloud Asset Inventory resource types that the custom module
* operates on. For information about resource types, see [Supported asset
* types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
* Each custom module can specify up to 5 resource types.
* </pre>
*
* <code>
Expand All @@ -4520,9 +4524,10 @@ public boolean hasResourceSelector() {
*
*
* <pre>
* Optional. The CAI resource types that the custom module operates on (see
* go/gcp-cai-doc/supported-asset-types). Each custom module can specify up to
* 5 resource types.
* Optional. The Cloud Asset Inventory resource types that the custom module
* operates on. For information about resource types, see [Supported asset
* types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
* Each custom module can specify up to 5 resource types.
* </pre>
*
* <code>
Expand All @@ -4546,9 +4551,10 @@ public boolean hasResourceSelector() {
*
*
* <pre>
* Optional. The CAI resource types that the custom module operates on (see
* go/gcp-cai-doc/supported-asset-types). Each custom module can specify up to
* 5 resource types.
* Optional. The Cloud Asset Inventory resource types that the custom module
* operates on. For information about resource types, see [Supported asset
* types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
* Each custom module can specify up to 5 resource types.
* </pre>
*
* <code>
Expand All @@ -4573,9 +4579,10 @@ public Builder setResourceSelector(
*
*
* <pre>
* Optional. The CAI resource types that the custom module operates on (see
* go/gcp-cai-doc/supported-asset-types). Each custom module can specify up to
* 5 resource types.
* Optional. The Cloud Asset Inventory resource types that the custom module
* operates on. For information about resource types, see [Supported asset
* types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
* Each custom module can specify up to 5 resource types.
* </pre>
*
* <code>
Expand All @@ -4598,9 +4605,10 @@ public Builder setResourceSelector(
*
*
* <pre>
* Optional. The CAI resource types that the custom module operates on (see
* go/gcp-cai-doc/supported-asset-types). Each custom module can specify up to
* 5 resource types.
* Optional. The Cloud Asset Inventory resource types that the custom module
* operates on. For information about resource types, see [Supported asset
* types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
* Each custom module can specify up to 5 resource types.
* </pre>
*
* <code>
Expand Down Expand Up @@ -4632,9 +4640,10 @@ public Builder mergeResourceSelector(
*
*
* <pre>
* Optional. The CAI resource types that the custom module operates on (see
* go/gcp-cai-doc/supported-asset-types). Each custom module can specify up to
* 5 resource types.
* Optional. The Cloud Asset Inventory resource types that the custom module
* operates on. For information about resource types, see [Supported asset
* types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
* Each custom module can specify up to 5 resource types.
* </pre>
*
* <code>
Expand All @@ -4655,9 +4664,10 @@ public Builder clearResourceSelector() {
*
*
* <pre>
* Optional. The CAI resource types that the custom module operates on (see
* go/gcp-cai-doc/supported-asset-types). Each custom module can specify up to
* 5 resource types.
* Optional. The Cloud Asset Inventory resource types that the custom module
* operates on. For information about resource types, see [Supported asset
* types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
* Each custom module can specify up to 5 resource types.
* </pre>
*
* <code>
Expand All @@ -4674,9 +4684,10 @@ public Builder clearResourceSelector() {
*
*
* <pre>
* Optional. The CAI resource types that the custom module operates on (see
* go/gcp-cai-doc/supported-asset-types). Each custom module can specify up to
* 5 resource types.
* Optional. The Cloud Asset Inventory resource types that the custom module
* operates on. For information about resource types, see [Supported asset
* types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
* Each custom module can specify up to 5 resource types.
* </pre>
*
* <code>
Expand All @@ -4698,9 +4709,10 @@ public Builder clearResourceSelector() {
*
*
* <pre>
* Optional. The CAI resource types that the custom module operates on (see
* go/gcp-cai-doc/supported-asset-types). Each custom module can specify up to
* 5 resource types.
* Optional. The Cloud Asset Inventory resource types that the custom module
* operates on. For information about resource types, see [Supported asset
* types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
* Each custom module can specify up to 5 resource types.
* </pre>
*
* <code>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,10 @@ public interface CustomConfigOrBuilder
*
*
* <pre>
* Optional. The CAI resource types that the custom module operates on (see
* go/gcp-cai-doc/supported-asset-types). Each custom module can specify up to
* 5 resource types.
* Optional. The Cloud Asset Inventory resource types that the custom module
* operates on. For information about resource types, see [Supported asset
* types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
* Each custom module can specify up to 5 resource types.
* </pre>
*
* <code>
Expand All @@ -124,9 +125,10 @@ public interface CustomConfigOrBuilder
*
*
* <pre>
* Optional. The CAI resource types that the custom module operates on (see
* go/gcp-cai-doc/supported-asset-types). Each custom module can specify up to
* 5 resource types.
* Optional. The Cloud Asset Inventory resource types that the custom module
* operates on. For information about resource types, see [Supported asset
* types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
* Each custom module can specify up to 5 resource types.
* </pre>
*
* <code>
Expand All @@ -140,9 +142,10 @@ public interface CustomConfigOrBuilder
*
*
* <pre>
* Optional. The CAI resource types that the custom module operates on (see
* go/gcp-cai-doc/supported-asset-types). Each custom module can specify up to
* 5 resource types.
* Optional. The Cloud Asset Inventory resource types that the custom module
* operates on. For information about resource types, see [Supported asset
* types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
* Each custom module can specify up to 5 resource types.
* </pre>
*
* <code>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ service SecurityCenterManagement {
}

// Returns a list of all resident SecurityHealthAnalyticsCustomModules under
// the given CRM parent and all of the parents CRM descendants.
// the given CRM parent and all of the parent's CRM descendants.
rpc ListDescendantSecurityHealthAnalyticsCustomModules(
ListDescendantSecurityHealthAnalyticsCustomModulesRequest)
returns (ListDescendantSecurityHealthAnalyticsCustomModulesResponse) {
Expand Down Expand Up @@ -635,9 +635,10 @@ message CustomConfig {
// Optional. Custom output properties.
CustomOutputSpec custom_output = 2 [(google.api.field_behavior) = OPTIONAL];

// Optional. The CAI resource types that the custom module operates on (see
// go/gcp-cai-doc/supported-asset-types). Each custom module can specify up to
// 5 resource types.
// Optional. The Cloud Asset Inventory resource types that the custom module
// operates on. For information about resource types, see [Supported asset
// types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
// Each custom module can specify up to 5 resource types.
ResourceSelector resource_selector = 3
[(google.api.field_behavior) = OPTIONAL];

Expand Down
Loading