Skip to content

Commit

Permalink
docs: Modify documentation of SimulateSecurityHealthAnalyticsCustomMo…
Browse files Browse the repository at this point in the history
…duleRequest

PiperOrigin-RevId: 584348542
  • Loading branch information
Google APIs authored and Copybara-Service committed Nov 21, 2023
1 parent 0f85c39 commit d2efcaa
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions google/cloud/securitycenter/v1/securitycenter_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -2054,15 +2054,16 @@ message RunAssetDiscoveryRequest {
// Request message to simulate a CustomConfig against a given test resource.
// Maximum size of the request is 4 MB by default.
message SimulateSecurityHealthAnalyticsCustomModuleRequest {
// Manually constructed resource. If the custom module only evaluates against
// the resource data, the iam_policy_data field can be omitted, and vice
// versa.
// Manually constructed resource name. If the custom module evaluates against
// only the resource data, you can omit the `iam_policy_data` field. If it
// evaluates only the `iam_policy_data` field, you can omit the resource data.
message SimulatedResource {
// Required. The type of the resource, e.g. `compute.googleapis.com/Disk`.
// Required. The type of the resource, for example,
// `compute.googleapis.com/Disk`.
string resource_type = 1 [(google.api.field_behavior) = REQUIRED];

// Optional. A representation of the GCP resource. Should match the GCP
// resource JSON format.
// Optional. A representation of the Google Cloud resource. Should match the
// Google Cloud resource JSON format.
google.protobuf.Struct resource_data = 2
[(google.api.field_behavior) = OPTIONAL];

Expand All @@ -2072,21 +2073,21 @@ message SimulateSecurityHealthAnalyticsCustomModuleRequest {
}

// Required. The relative resource name of the organization, project, or
// folder. See:
// https://cloud.google.com/apis/design/resource_names#relative_resource_name
// An example is:
// "organizations/{organization_id}".
// folder. For more information about relative resource names, see [Relative
// Resource
// Name](https://cloud.google.com/apis/design/resource_names#relative_resource_name)
// Example: `organizations/{organization_id}`
string parent = 1 [(google.api.field_behavior) = REQUIRED];

// Required. The user specified custom configuration to test.
// Required. The custom configuration that you need to test.
CustomConfig custom_config = 2 [(google.api.field_behavior) = REQUIRED];

// Required. Resource data to simulate custom module against.
SimulatedResource resource = 3 [(google.api.field_behavior) = REQUIRED];
}

// Response message for simulating a SecurityHealthAnalyticsCustomModule against
// a given resource.
// Response message for simulating a `SecurityHealthAnalyticsCustomModule`
// against a given resource.
message SimulateSecurityHealthAnalyticsCustomModuleResponse {
// Possible test result.
message SimulatedResult {
Expand Down

0 comments on commit d2efcaa

Please sign in to comment.