diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/create_event_threat_detection_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/create_event_threat_detection_custom_module.php index 50ecd584c107..81b5a3200e76 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/create_event_threat_detection_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/create_event_threat_detection_custom_module.php @@ -30,15 +30,15 @@ /** * Creates a resident Event Threat Detection custom module at the scope of the - * given Resource Manager parent, and also creates inherited custom modules - * for all descendants of the given parent. These modules are enabled by - * default. + * given organization, folder, or project, and creates inherited custom + * modules for all descendants of the given parent. These modules are enabled + * by default. * - * @param string $formattedParent Name of parent for the module. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * @param string $formattedParent Name of parent for the module, in one of the following formats: + * + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. */ function create_event_threat_detection_custom_module_sample(string $formattedParent): void diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/create_security_health_analytics_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/create_security_health_analytics_custom_module.php index b06b2f1af7cf..0ca1e4eab3a8 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/create_security_health_analytics_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/create_security_health_analytics_custom_module.php @@ -29,13 +29,15 @@ use Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule; /** - * Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the - * given CRM parent, and also creates inherited - * SecurityHealthAnalyticsCustomModules for all CRM descendants of the given - * parent. These modules are enabled by default. + * Creates a resident + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * at the scope of the given organization, folder, or project, and also + * creates inherited `SecurityHealthAnalyticsCustomModule` resources for all + * folders and projects that are descendants of the given parent. These + * modules are enabled by default. * * @param string $formattedParent Name of the parent organization, folder, or project of the - * module, specified in one of the following formats: + * module, in one of the following formats: * * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/delete_event_threat_detection_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/delete_event_threat_detection_custom_module.php index e922d9c138b4..037bf5606d29 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/delete_event_threat_detection_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/delete_event_threat_detection_custom_module.php @@ -29,17 +29,16 @@ /** * Deletes the specified Event Threat Detection custom module and all of its - * descendants in the Resource Manager hierarchy. This method is only - * supported for resident custom modules. + * descendants in the resource hierarchy. This method is only supported for + * resident custom modules. * - * @param string $formattedName The resource name of the ETD custom module. + * @param string $formattedName The resource name of the Event Threat Detection custom module, in + * one of the following formats: * - * Its format is: - * - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. Please see - * {@see SecurityCenterManagementClient::eventThreatDetectionCustomModuleName()} for help formatting this field. + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * Please see {@see SecurityCenterManagementClient::eventThreatDetectionCustomModuleName()} for help formatting this field. */ function delete_event_threat_detection_custom_module_sample(string $formattedName): void { diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/delete_security_health_analytics_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/delete_security_health_analytics_custom_module.php index 2a00edf4efa0..d091d37a37aa 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/delete_security_health_analytics_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/delete_security_health_analytics_custom_module.php @@ -28,18 +28,18 @@ use Google\Cloud\SecurityCenterManagement\V1\DeleteSecurityHealthAnalyticsCustomModuleRequest; /** - * Deletes the specified SecurityHealthAnalyticsCustomModule and all of its - * descendants in the CRM hierarchy. This method is only supported for - * resident custom modules. + * Deletes the specified + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * and all of its descendants in the resource hierarchy. This method is only + * supported for resident custom modules. * - * @param string $formattedName The resource name of the SHA custom module. + * @param string $formattedName The resource name of the SHA custom module, in one of the + * following formats: * - * Its format is: - * - * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. Please see - * {@see SecurityCenterManagementClient::securityHealthAnalyticsCustomModuleName()} for help formatting this field. + * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * Please see {@see SecurityCenterManagementClient::securityHealthAnalyticsCustomModuleName()} for help formatting this field. */ function delete_security_health_analytics_custom_module_sample(string $formattedName): void { diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_effective_event_threat_detection_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_effective_event_threat_detection_custom_module.php index fe58910a54e0..ea49eb73b255 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_effective_event_threat_detection_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_effective_event_threat_detection_custom_module.php @@ -29,22 +29,26 @@ use Google\Cloud\SecurityCenterManagement\V1\GetEffectiveEventThreatDetectionCustomModuleRequest; /** - * Gets an effective ETD custom module. Retrieves the effective module at the - * given level. The difference between an EffectiveCustomModule and a - * CustomModule is that the fields for an EffectiveCustomModule are computed - * from ancestors if needed. For example, the enablement_state for a - * CustomModule can be either ENABLED, DISABLED, or INHERITED. Where as the - * enablement_state for an EffectiveCustomModule is always computed to ENABLED - * or DISABLED (the effective enablement_state). + * Gets the effective Event Threat Detection custom module at the given level. * - * @param string $formattedName The resource name of the ETD custom module. + * The difference between an + * [EffectiveEventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule] + * and an + * [EventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule] + * is that the fields for an `EffectiveEventThreatDetectionCustomModule` are + * computed from ancestors if needed. For example, the enablement state for an + * `EventThreatDetectionCustomModule` can be `ENABLED`, `DISABLED`, or + * `INHERITED`. In contrast, the enablement state for an + * `EffectiveEventThreatDetectionCustomModule` is always computed as `ENABLED` + * or `DISABLED`. * - * Its format is: + * @param string $formattedName The resource name of the Event Threat Detection custom module, in + * one of the following formats: * - * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. Please see - * {@see SecurityCenterManagementClient::effectiveEventThreatDetectionCustomModuleName()} for help formatting this field. + * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * Please see {@see SecurityCenterManagementClient::effectiveEventThreatDetectionCustomModuleName()} for help formatting this field. */ function get_effective_event_threat_detection_custom_module_sample(string $formattedName): void { diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_effective_security_health_analytics_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_effective_security_health_analytics_custom_module.php index 4fce6bdac6fd..a29efacadea5 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_effective_security_health_analytics_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_effective_security_health_analytics_custom_module.php @@ -29,14 +29,15 @@ use Google\Cloud\SecurityCenterManagement\V1\GetEffectiveSecurityHealthAnalyticsCustomModuleRequest; /** - * Gets details of a single EffectiveSecurityHealthAnalyticsCustomModule. + * Gets details of a single + * [EffectiveSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule]. * * @param string $formattedName The full resource name of the custom module, specified in one of * the following formats: * - * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` + * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` * Please see {@see SecurityCenterManagementClient::effectiveSecurityHealthAnalyticsCustomModuleName()} for help formatting this field. */ function get_effective_security_health_analytics_custom_module_sample(string $formattedName): void diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_event_threat_detection_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_event_threat_detection_custom_module.php index ed1a4f16a9b8..0cc5f41f724b 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_event_threat_detection_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_event_threat_detection_custom_module.php @@ -31,14 +31,13 @@ /** * Gets an Event Threat Detection custom module. * - * @param string $formattedName The resource name of the ETD custom module. + * @param string $formattedName The resource name of the Event Threat Detection custom module, in + * one of the following formats: * - * Its format is: - * - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. Please see - * {@see SecurityCenterManagementClient::eventThreatDetectionCustomModuleName()} for help formatting this field. + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * Please see {@see SecurityCenterManagementClient::eventThreatDetectionCustomModuleName()} for help formatting this field. */ function get_event_threat_detection_custom_module_sample(string $formattedName): void { diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_security_center_service.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_security_center_service.php index a832f451e258..2c8de8e189b7 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_security_center_service.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_security_center_service.php @@ -31,21 +31,20 @@ /** * Gets service settings for the specified Security Command Center service. * - * @param string $formattedName The Security Command Center service to retrieve. - * - * Formats: + * @param string $formattedName The Security Command Center service to retrieve, in one of the + * following formats: * * * organizations/{organization}/locations/{location}/securityCenterServices/{service} * * folders/{folder}/locations/{location}/securityCenterServices/{service} * * projects/{project}/locations/{location}/securityCenterServices/{service} * - * The possible values for id {service} are: + * The following values are valid for `{service}`: * - * * container-threat-detection - * * event-threat-detection - * * security-health-analytics - * * vm-threat-detection - * * web-security-scanner + * * `container-threat-detection` + * * `event-threat-detection` + * * `security-health-analytics` + * * `vm-threat-detection` + * * `web-security-scanner` * Please see {@see SecurityCenterManagementClient::securityCenterServiceName()} for help formatting this field. */ function get_security_center_service_sample(string $formattedName): void diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_security_health_analytics_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_security_health_analytics_custom_module.php index 6043528b6c06..180a19f95dfd 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_security_health_analytics_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_security_health_analytics_custom_module.php @@ -29,10 +29,12 @@ use Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule; /** - * Retrieves a SecurityHealthAnalyticsCustomModule. + * Retrieves a + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule]. * - * @param string $formattedName Name of the resource - * Please see {@see SecurityCenterManagementClient::securityHealthAnalyticsCustomModuleName()} for help formatting this field. + * @param string $formattedName Name of the resource, in the format + * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`. Please see + * {@see SecurityCenterManagementClient::securityHealthAnalyticsCustomModuleName()} for help formatting this field. */ function get_security_health_analytics_custom_module_sample(string $formattedName): void { diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_descendant_event_threat_detection_custom_modules.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_descendant_event_threat_detection_custom_modules.php index 23c295c639b4..a8546c3f1a65 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_descendant_event_threat_detection_custom_modules.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_descendant_event_threat_detection_custom_modules.php @@ -30,14 +30,15 @@ use Google\Cloud\SecurityCenterManagement\V1\ListDescendantEventThreatDetectionCustomModulesRequest; /** - * Lists all resident Event Threat Detection custom modules under the - * given Resource Manager parent and its descendants. + * Lists all resident Event Threat Detection custom modules for the given + * organization, folder, or project and its descendants. * - * @param string $formattedParent Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * @param string $formattedParent Name of parent to list custom modules, in one of the following + * formats: + * + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. */ function list_descendant_event_threat_detection_custom_modules_sample( diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_descendant_security_health_analytics_custom_modules.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_descendant_security_health_analytics_custom_modules.php index 16b8fca809b1..4152fe5b66f7 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_descendant_security_health_analytics_custom_modules.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_descendant_security_health_analytics_custom_modules.php @@ -30,11 +30,13 @@ use Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule; /** - * Returns a list of all resident SecurityHealthAnalyticsCustomModules under - * the given CRM parent and all of the parent's CRM descendants. + * Returns a list of all resident + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * resources under the given organization, folder, or project and all of its + * descendants. * * @param string $formattedParent Name of the parent organization, folder, or project in which to - * list custom modules, specified in one of the following formats: + * list custom modules, in one of the following formats: * * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_effective_event_threat_detection_custom_modules.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_effective_event_threat_detection_custom_modules.php index 033056c3a15d..49a344eddaf8 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_effective_event_threat_detection_custom_modules.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_effective_event_threat_detection_custom_modules.php @@ -34,11 +34,12 @@ * given parent. This includes resident modules defined at the scope of the * parent along with modules inherited from its ancestors. * - * @param string $formattedParent Name of parent to list effective custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * @param string $formattedParent Name of parent to list effective custom modules, in one of the + * following formats: + * + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. */ function list_effective_event_threat_detection_custom_modules_sample( diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_effective_security_health_analytics_custom_modules.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_effective_security_health_analytics_custom_modules.php index e752bde456c7..4cee92b3aea9 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_effective_security_health_analytics_custom_modules.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_effective_security_health_analytics_custom_modules.php @@ -30,17 +30,18 @@ use Google\Cloud\SecurityCenterManagement\V1\ListEffectiveSecurityHealthAnalyticsCustomModulesRequest; /** - * Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the - * given parent. This includes resident modules defined at the scope of the - * parent, and inherited modules, inherited from CRM ancestors (no - * descendants). + * Returns a list of all + * [EffectiveSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule] + * resources for the given parent. This includes resident modules defined at + * the scope of the parent, and inherited modules, inherited from ancestor + * organizations, folders, and projects (no descendants). + * + * @param string $formattedParent Name of parent to list effective custom modules, in one of the + * following formats: * - * @param string $formattedParent Name of parent to list effective custom modules. specified in one - * of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` - * or - * `projects/{project}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. */ function list_effective_security_health_analytics_custom_modules_sample( diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_event_threat_detection_custom_modules.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_event_threat_detection_custom_modules.php index 3d1de8512479..145383c1ef71 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_event_threat_detection_custom_modules.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_event_threat_detection_custom_modules.php @@ -30,15 +30,16 @@ use Google\Cloud\SecurityCenterManagement\V1\ListEventThreatDetectionCustomModulesRequest; /** - * Lists all Event Threat Detection custom modules for the given - * Resource Manager parent. This includes resident modules defined at the - * scope of the parent along with modules inherited from ancestors. + * Lists all Event Threat Detection custom modules for the given organization, + * folder, or project. This includes resident modules defined at the scope of + * the parent along with modules inherited from ancestors. * - * @param string $formattedParent Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * @param string $formattedParent Name of parent to list custom modules, in one of the following + * formats: + * + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. */ function list_event_threat_detection_custom_modules_sample(string $formattedParent): void diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_security_center_services.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_security_center_services.php index ead3764fc0b0..4e2688825d08 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_security_center_services.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_security_center_services.php @@ -33,13 +33,12 @@ * Returns a list of all Security Command Center services for the given * parent. * - * @param string $formattedParent The name of the parent to list Security Command Center services. + * @param string $formattedParent The name of the parent to list Security Command Center services, + * in one of the following formats: * - * Formats: - * - * * organizations/{organization}/locations/{location} - * * folders/{folder}/locations/{location} - * * projects/{project}/locations/{location} + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. */ function list_security_center_services_sample(string $formattedParent): void diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_security_health_analytics_custom_modules.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_security_health_analytics_custom_modules.php index 345420db4ca7..741d1cc0e1d7 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_security_health_analytics_custom_modules.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_security_health_analytics_custom_modules.php @@ -30,12 +30,14 @@ use Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule; /** - * Returns a list of all SecurityHealthAnalyticsCustomModules for the given - * parent. This includes resident modules defined at the scope of the parent, - * and inherited modules, inherited from CRM ancestors (no descendants). + * Returns a list of all + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * resources for the given parent. This includes resident modules defined at + * the scope of the parent, and inherited modules, inherited from ancestor + * organizations, folders, and projects (no descendants). * - * @param string $formattedParent Name of parent organization, folder, or project in which to list - * custom modules, specified in one of the following formats: + * @param string $formattedParent Name of the parent organization, folder, or project in which to + * list custom modules, in one of the following formats: * * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/simulate_security_health_analytics_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/simulate_security_health_analytics_custom_module.php index f5fd2a907173..67a0d4421b7d 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/simulate_security_health_analytics_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/simulate_security_health_analytics_custom_module.php @@ -31,14 +31,15 @@ use Google\Cloud\SecurityCenterManagement\V1\SimulateSecurityHealthAnalyticsCustomModuleResponse; /** - * Simulates a given SecurityHealthAnalyticsCustomModule and Resource. + * Simulates the result of using a + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * to check a resource. * * @param string $parent The relative resource name of the organization, project, or - * 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}`. - * @param string $resourceResourceType The type of the resource, for example, + * folder. For more information about relative resource names, see [AIP-122: + * Resource names](https://google.aip.dev/122). Example: + * `organizations/{organization_id}`. + * @param string $resourceResourceType The type of the resource. For example, * `compute.googleapis.com/Disk`. */ function simulate_security_health_analytics_custom_module_sample( diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/update_security_health_analytics_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/update_security_health_analytics_custom_module.php index 6a18083f0e89..481d217ab836 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/update_security_health_analytics_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/update_security_health_analytics_custom_module.php @@ -30,11 +30,13 @@ use Google\Protobuf\FieldMask; /** - * Updates the SecurityHealthAnalyticsCustomModule under the given name based - * on the given update mask. Updating the enablement state is supported on - * both resident and inherited modules (though resident modules cannot have an - * enablement state of "inherited"). Updating the display name and custom - * config of a module is supported on resident modules only. + * Updates the + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * under the given name based on the given update mask. Updating the + * enablement state is supported on both resident and inherited modules + * (though resident modules cannot have an enablement state of "inherited"). + * Updating the display name and custom configuration of a module is supported + * on resident modules only. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/validate_event_threat_detection_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/validate_event_threat_detection_custom_module.php index 651855f64a10..075782bbdab8 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/validate_event_threat_detection_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/validate_event_threat_detection_custom_module.php @@ -31,15 +31,14 @@ /** * Validates the given Event Threat Detection custom module. * - * @param string $formattedParent Resource name of the parent to validate the Custom Module under. + * @param string $formattedParent Resource name of the parent to validate the custom modules under, + * in one of the following formats: * - * Its format is: - * - * * `organizations/{organization}/locations/{location}`. Please see - * {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. + * * `organizations/{organization}/locations/{location}` + * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. * @param string $rawText The raw text of the module's contents. Used to generate error * messages. - * @param string $type The type of the module (e.g. CONFIGURABLE_BAD_IP). + * @param string $type The type of the module. For example, `CONFIGURABLE_BAD_IP`. */ function validate_event_threat_detection_custom_module_sample( string $formattedParent, diff --git a/SecurityCenterManagement/src/V1/Client/SecurityCenterManagementClient.php b/SecurityCenterManagement/src/V1/Client/SecurityCenterManagementClient.php index 5de09763fb26..b750d3f4aa06 100644 --- a/SecurityCenterManagement/src/V1/Client/SecurityCenterManagementClient.php +++ b/SecurityCenterManagement/src/V1/Client/SecurityCenterManagementClient.php @@ -750,9 +750,9 @@ public function __call($method, $args) /** * Creates a resident Event Threat Detection custom module at the scope of the - * given Resource Manager parent, and also creates inherited custom modules - * for all descendants of the given parent. These modules are enabled by - * default. + * given organization, folder, or project, and creates inherited custom + * modules for all descendants of the given parent. These modules are enabled + * by default. * * The async variant is * {@see SecurityCenterManagementClient::createEventThreatDetectionCustomModuleAsync()} @@ -782,10 +782,12 @@ public function createEventThreatDetectionCustomModule( } /** - * Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the - * given CRM parent, and also creates inherited - * SecurityHealthAnalyticsCustomModules for all CRM descendants of the given - * parent. These modules are enabled by default. + * Creates a resident + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * at the scope of the given organization, folder, or project, and also + * creates inherited `SecurityHealthAnalyticsCustomModule` resources for all + * folders and projects that are descendants of the given parent. These + * modules are enabled by default. * * The async variant is * {@see SecurityCenterManagementClient::createSecurityHealthAnalyticsCustomModuleAsync()} @@ -816,8 +818,8 @@ public function createSecurityHealthAnalyticsCustomModule( /** * Deletes the specified Event Threat Detection custom module and all of its - * descendants in the Resource Manager hierarchy. This method is only - * supported for resident custom modules. + * descendants in the resource hierarchy. This method is only supported for + * resident custom modules. * * The async variant is * {@see SecurityCenterManagementClient::deleteEventThreatDetectionCustomModuleAsync()} @@ -845,9 +847,10 @@ public function deleteEventThreatDetectionCustomModule( } /** - * Deletes the specified SecurityHealthAnalyticsCustomModule and all of its - * descendants in the CRM hierarchy. This method is only supported for - * resident custom modules. + * Deletes the specified + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * and all of its descendants in the resource hierarchy. This method is only + * supported for resident custom modules. * * The async variant is * {@see SecurityCenterManagementClient::deleteSecurityHealthAnalyticsCustomModuleAsync()} @@ -875,13 +878,18 @@ public function deleteSecurityHealthAnalyticsCustomModule( } /** - * Gets an effective ETD custom module. Retrieves the effective module at the - * given level. The difference between an EffectiveCustomModule and a - * CustomModule is that the fields for an EffectiveCustomModule are computed - * from ancestors if needed. For example, the enablement_state for a - * CustomModule can be either ENABLED, DISABLED, or INHERITED. Where as the - * enablement_state for an EffectiveCustomModule is always computed to ENABLED - * or DISABLED (the effective enablement_state). + * Gets the effective Event Threat Detection custom module at the given level. + * + * The difference between an + * [EffectiveEventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule] + * and an + * [EventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule] + * is that the fields for an `EffectiveEventThreatDetectionCustomModule` are + * computed from ancestors if needed. For example, the enablement state for an + * `EventThreatDetectionCustomModule` can be `ENABLED`, `DISABLED`, or + * `INHERITED`. In contrast, the enablement state for an + * `EffectiveEventThreatDetectionCustomModule` is always computed as `ENABLED` + * or `DISABLED`. * * The async variant is * {@see SecurityCenterManagementClient::getEffectiveEventThreatDetectionCustomModuleAsync()} @@ -911,7 +919,8 @@ public function getEffectiveEventThreatDetectionCustomModule( } /** - * Gets details of a single EffectiveSecurityHealthAnalyticsCustomModule. + * Gets details of a single + * [EffectiveSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule]. * * The async variant is * {@see SecurityCenterManagementClient::getEffectiveSecurityHealthAnalyticsCustomModuleAsync()} @@ -1000,7 +1009,8 @@ public function getSecurityCenterService( } /** - * Retrieves a SecurityHealthAnalyticsCustomModule. + * Retrieves a + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule]. * * The async variant is * {@see SecurityCenterManagementClient::getSecurityHealthAnalyticsCustomModuleAsync()} @@ -1030,8 +1040,8 @@ public function getSecurityHealthAnalyticsCustomModule( } /** - * Lists all resident Event Threat Detection custom modules under the - * given Resource Manager parent and its descendants. + * Lists all resident Event Threat Detection custom modules for the given + * organization, folder, or project and its descendants. * * The async variant is * {@see SecurityCenterManagementClient::listDescendantEventThreatDetectionCustomModulesAsync()} @@ -1061,8 +1071,10 @@ public function listDescendantEventThreatDetectionCustomModules( } /** - * Returns a list of all resident SecurityHealthAnalyticsCustomModules under - * the given CRM parent and all of the parent's CRM descendants. + * Returns a list of all resident + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * resources under the given organization, folder, or project and all of its + * descendants. * * The async variant is * {@see SecurityCenterManagementClient::listDescendantSecurityHealthAnalyticsCustomModulesAsync()} @@ -1124,10 +1136,11 @@ public function listEffectiveEventThreatDetectionCustomModules( } /** - * Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the - * given parent. This includes resident modules defined at the scope of the - * parent, and inherited modules, inherited from CRM ancestors (no - * descendants). + * Returns a list of all + * [EffectiveSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule] + * resources for the given parent. This includes resident modules defined at + * the scope of the parent, and inherited modules, inherited from ancestor + * organizations, folders, and projects (no descendants). * * The async variant is * {@see SecurityCenterManagementClient::listEffectiveSecurityHealthAnalyticsCustomModulesAsync()} @@ -1157,9 +1170,9 @@ public function listEffectiveSecurityHealthAnalyticsCustomModules( } /** - * Lists all Event Threat Detection custom modules for the given - * Resource Manager parent. This includes resident modules defined at the - * scope of the parent along with modules inherited from ancestors. + * Lists all Event Threat Detection custom modules for the given organization, + * folder, or project. This includes resident modules defined at the scope of + * the parent along with modules inherited from ancestors. * * The async variant is * {@see SecurityCenterManagementClient::listEventThreatDetectionCustomModulesAsync()} @@ -1219,9 +1232,11 @@ public function listSecurityCenterServices( } /** - * Returns a list of all SecurityHealthAnalyticsCustomModules for the given - * parent. This includes resident modules defined at the scope of the parent, - * and inherited modules, inherited from CRM ancestors (no descendants). + * Returns a list of all + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * resources for the given parent. This includes resident modules defined at + * the scope of the parent, and inherited modules, inherited from ancestor + * organizations, folders, and projects (no descendants). * * The async variant is * {@see SecurityCenterManagementClient::listSecurityHealthAnalyticsCustomModulesAsync()} @@ -1251,7 +1266,9 @@ public function listSecurityHealthAnalyticsCustomModules( } /** - * Simulates a given SecurityHealthAnalyticsCustomModule and Resource. + * Simulates the result of using a + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * to check a resource. * * The async variant is * {@see SecurityCenterManagementClient::simulateSecurityHealthAnalyticsCustomModuleAsync()} @@ -1345,11 +1362,13 @@ public function updateSecurityCenterService( } /** - * Updates the SecurityHealthAnalyticsCustomModule under the given name based - * on the given update mask. Updating the enablement state is supported on - * both resident and inherited modules (though resident modules cannot have an - * enablement state of "inherited"). Updating the display name and custom - * config of a module is supported on resident modules only. + * Updates the + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * under the given name based on the given update mask. Updating the + * enablement state is supported on both resident and inherited modules + * (though resident modules cannot have an enablement state of "inherited"). + * Updating the display name and custom configuration of a module is supported + * on resident modules only. * * The async variant is * {@see SecurityCenterManagementClient::updateSecurityHealthAnalyticsCustomModuleAsync()} diff --git a/SecurityCenterManagement/src/V1/CreateEventThreatDetectionCustomModuleRequest.php b/SecurityCenterManagement/src/V1/CreateEventThreatDetectionCustomModuleRequest.php index f10cdbc65818..89fe34cb5e6e 100644 --- a/SecurityCenterManagement/src/V1/CreateEventThreatDetectionCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/CreateEventThreatDetectionCustomModuleRequest.php @@ -9,53 +9,56 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Message for creating a EventThreatDetectionCustomModule + * Request message for + * [SecurityCenterManagement.CreateEventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.CreateEventThreatDetectionCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.CreateEventThreatDetectionCustomModuleRequest */ class CreateEventThreatDetectionCustomModuleRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Name of parent for the module. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent for the module, in one of the following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $parent = ''; /** * Required. The module to create. The - * event_threat_detection_custom_module.name will be ignored and server - * generated. + * [EventThreatDetectionCustomModule.name][google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule.name] + * field is ignored; Security Command Center generates the name. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_module = 3 [(.google.api.field_behavior) = REQUIRED]; */ protected $event_threat_detection_custom_module = null; /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (no module will be created). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually create the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred during creation of the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be created. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to create the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; */ protected $validate_only = false; /** - * @param string $parent Required. Name of parent for the module. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * @param string $parent Required. Name of parent for the module, in one of the following formats: + * + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. * @param \Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule $eventThreatDetectionCustomModule Required. The module to create. The - * event_threat_detection_custom_module.name will be ignored and server - * generated. + * [EventThreatDetectionCustomModule.name][google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule.name] + * field is ignored; Security Command Center generates the name. * * @return \Google\Cloud\SecurityCenterManagement\V1\CreateEventThreatDetectionCustomModuleRequest * @@ -75,23 +78,25 @@ public static function build(string $parent, \Google\Cloud\SecurityCenterManagem * Optional. Data for populating the Message object. * * @type string $parent - * Required. Name of parent for the module. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent for the module, in one of the following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * @type \Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule $event_threat_detection_custom_module * Required. The module to create. The - * event_threat_detection_custom_module.name will be ignored and server - * generated. + * [EventThreatDetectionCustomModule.name][google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule.name] + * field is ignored; Security Command Center generates the name. * @type bool $validate_only - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (no module will be created). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually create the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred during creation of the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be created. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to create the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * } */ public function __construct($data = NULL) { @@ -100,11 +105,10 @@ public function __construct($data = NULL) { } /** - * Required. Name of parent for the module. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent for the module, in one of the following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -115,11 +119,10 @@ public function getParent() } /** - * Required. Name of parent for the module. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent for the module, in one of the following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -135,8 +138,8 @@ public function setParent($var) /** * Required. The module to create. The - * event_threat_detection_custom_module.name will be ignored and server - * generated. + * [EventThreatDetectionCustomModule.name][google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule.name] + * field is ignored; Security Command Center generates the name. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_module = 3 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule|null @@ -158,8 +161,8 @@ public function clearEventThreatDetectionCustomModule() /** * Required. The module to create. The - * event_threat_detection_custom_module.name will be ignored and server - * generated. + * [EventThreatDetectionCustomModule.name][google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule.name] + * field is ignored; Security Command Center generates the name. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_module = 3 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule $var @@ -174,13 +177,16 @@ public function setEventThreatDetectionCustomModule($var) } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (no module will be created). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually create the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred during creation of the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be created. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to create the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -191,13 +197,16 @@ public function getValidateOnly() } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (no module will be created). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually create the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred during creation of the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be created. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to create the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/SecurityCenterManagement/src/V1/CreateSecurityHealthAnalyticsCustomModuleRequest.php b/SecurityCenterManagement/src/V1/CreateSecurityHealthAnalyticsCustomModuleRequest.php index 582fa03482dc..97b0a5189124 100644 --- a/SecurityCenterManagement/src/V1/CreateSecurityHealthAnalyticsCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/CreateSecurityHealthAnalyticsCustomModuleRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Message for creating a SecurityHealthAnalyticsCustomModule + * Request message for + * [SecurityCenterManagement.CreateSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.CreateSecurityHealthAnalyticsCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.CreateSecurityHealthAnalyticsCustomModuleRequest */ @@ -17,7 +18,7 @@ class CreateSecurityHealthAnalyticsCustomModuleRequest extends \Google\Protobuf\ { /** * Required. Name of the parent organization, folder, or project of the - * module, specified in one of the following formats: + * module, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -26,20 +27,22 @@ class CreateSecurityHealthAnalyticsCustomModuleRequest extends \Google\Protobuf\ */ protected $parent = ''; /** - * Required. The resource being created + * Required. The resource being created. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule security_health_analytics_custom_module = 2 [(.google.api.field_behavior) = REQUIRED]; */ protected $security_health_analytics_custom_module = null; /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (no module will be created). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually create the module could - * still fail because: - * 1. the state could have changed (e.g. IAM permission lost) or - * 2. A failure occurred during creation of the module. - * Defaults to false. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be created. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to create the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -47,13 +50,13 @@ class CreateSecurityHealthAnalyticsCustomModuleRequest extends \Google\Protobuf\ /** * @param string $parent Required. Name of the parent organization, folder, or project of the - * module, specified in one of the following formats: + * module, in one of the following formats: * * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. - * @param \Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule $securityHealthAnalyticsCustomModule Required. The resource being created + * @param \Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule $securityHealthAnalyticsCustomModule Required. The resource being created. * * @return \Google\Cloud\SecurityCenterManagement\V1\CreateSecurityHealthAnalyticsCustomModuleRequest * @@ -74,21 +77,23 @@ public static function build(string $parent, \Google\Cloud\SecurityCenterManagem * * @type string $parent * Required. Name of the parent organization, folder, or project of the - * module, specified in one of the following formats: + * module, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` * @type \Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule $security_health_analytics_custom_module - * Required. The resource being created + * Required. The resource being created. * @type bool $validate_only - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (no module will be created). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually create the module could - * still fail because: - * 1. the state could have changed (e.g. IAM permission lost) or - * 2. A failure occurred during creation of the module. - * Defaults to false. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be created. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to create the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * } */ public function __construct($data = NULL) { @@ -98,7 +103,7 @@ public function __construct($data = NULL) { /** * Required. Name of the parent organization, folder, or project of the - * module, specified in one of the following formats: + * module, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -113,7 +118,7 @@ public function getParent() /** * Required. Name of the parent organization, folder, or project of the - * module, specified in one of the following formats: + * module, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -131,7 +136,7 @@ public function setParent($var) } /** - * Required. The resource being created + * Required. The resource being created. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule security_health_analytics_custom_module = 2 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule|null @@ -152,7 +157,7 @@ public function clearSecurityHealthAnalyticsCustomModule() } /** - * Required. The resource being created + * Required. The resource being created. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule security_health_analytics_custom_module = 2 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule $var @@ -167,14 +172,16 @@ public function setSecurityHealthAnalyticsCustomModule($var) } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (no module will be created). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually create the module could - * still fail because: - * 1. the state could have changed (e.g. IAM permission lost) or - * 2. A failure occurred during creation of the module. - * Defaults to false. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be created. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to create the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -185,14 +192,16 @@ public function getValidateOnly() } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (no module will be created). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually create the module could - * still fail because: - * 1. the state could have changed (e.g. IAM permission lost) or - * 2. A failure occurred during creation of the module. - * Defaults to false. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be created. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to create the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/SecurityCenterManagement/src/V1/CustomConfig.php b/SecurityCenterManagement/src/V1/CustomConfig.php index 77cd3e176778..b753e6e848bc 100644 --- a/SecurityCenterManagement/src/V1/CustomConfig.php +++ b/SecurityCenterManagement/src/V1/CustomConfig.php @@ -18,8 +18,9 @@ class CustomConfig extends \Google\Protobuf\Internal\Message { /** - * Optional. The CEL expression to evaluate to produce findings. When the - * expression evaluates to true against a resource, a finding is generated. + * Optional. The Common Expression Language (CEL) expression to evaluate to + * produce findings. When the expression evaluates to `true` against a + * resource, a finding is generated. * * Generated from protobuf field .google.type.Expr predicate = 1 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -57,8 +58,7 @@ class CustomConfig extends \Google\Protobuf\Internal\Message /** * Optional. An explanation of the recommended steps that security teams can * take to resolve the detected issue. This explanation is returned with each - * finding generated by this module in the `nextSteps` property of the finding - * JSON. + * finding generated by this module. * * Generated from protobuf field string recommendation = 6 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -71,8 +71,9 @@ class CustomConfig extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Type\Expr $predicate - * Optional. The CEL expression to evaluate to produce findings. When the - * expression evaluates to true against a resource, a finding is generated. + * Optional. The Common Expression Language (CEL) expression to evaluate to + * produce findings. When the expression evaluates to `true` against a + * resource, a finding is generated. * @type \Google\Cloud\SecurityCenterManagement\V1\CustomConfig\CustomOutputSpec $custom_output * Optional. Custom output properties. * @type \Google\Cloud\SecurityCenterManagement\V1\CustomConfig\ResourceSelector $resource_selector @@ -90,8 +91,7 @@ class CustomConfig extends \Google\Protobuf\Internal\Message * @type string $recommendation * Optional. An explanation of the recommended steps that security teams can * take to resolve the detected issue. This explanation is returned with each - * finding generated by this module in the `nextSteps` property of the finding - * JSON. + * finding generated by this module. * } */ public function __construct($data = NULL) { @@ -100,8 +100,9 @@ public function __construct($data = NULL) { } /** - * Optional. The CEL expression to evaluate to produce findings. When the - * expression evaluates to true against a resource, a finding is generated. + * Optional. The Common Expression Language (CEL) expression to evaluate to + * produce findings. When the expression evaluates to `true` against a + * resource, a finding is generated. * * Generated from protobuf field .google.type.Expr predicate = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Type\Expr|null @@ -122,8 +123,9 @@ public function clearPredicate() } /** - * Optional. The CEL expression to evaluate to produce findings. When the - * expression evaluates to true against a resource, a finding is generated. + * Optional. The Common Expression Language (CEL) expression to evaluate to + * produce findings. When the expression evaluates to `true` against a + * resource, a finding is generated. * * Generated from protobuf field .google.type.Expr predicate = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Type\Expr $var @@ -276,8 +278,7 @@ public function setDescription($var) /** * Optional. An explanation of the recommended steps that security teams can * take to resolve the detected issue. This explanation is returned with each - * finding generated by this module in the `nextSteps` property of the finding - * JSON. + * finding generated by this module. * * Generated from protobuf field string recommendation = 6 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -290,8 +291,7 @@ public function getRecommendation() /** * Optional. An explanation of the recommended steps that security teams can * take to resolve the detected issue. This explanation is returned with each - * finding generated by this module in the `nextSteps` property of the finding - * JSON. + * finding generated by this module. * * Generated from protobuf field string recommendation = 6 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/CustomConfig/CustomOutputSpec.php b/SecurityCenterManagement/src/V1/CustomConfig/CustomOutputSpec.php index c858f968d0c9..ef5a4a680637 100644 --- a/SecurityCenterManagement/src/V1/CustomConfig/CustomOutputSpec.php +++ b/SecurityCenterManagement/src/V1/CustomConfig/CustomOutputSpec.php @@ -11,8 +11,7 @@ /** * A set of optional name-value pairs that define custom source properties to * return with each finding that is generated by the custom module. The custom - * source properties that are defined here are included in the finding JSON - * under `sourceProperties`. + * source properties that are defined here are included in the finding. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.CustomConfig.CustomOutputSpec */ diff --git a/SecurityCenterManagement/src/V1/CustomConfig/Severity.php b/SecurityCenterManagement/src/V1/CustomConfig/Severity.php index 2d8f54a47882..60d277b2e838 100644 --- a/SecurityCenterManagement/src/V1/CustomConfig/Severity.php +++ b/SecurityCenterManagement/src/V1/CustomConfig/Severity.php @@ -14,7 +14,7 @@ class Severity { /** - * Unspecified severity. + * Default value. This value is unused. * * Generated from protobuf enum SEVERITY_UNSPECIFIED = 0; */ diff --git a/SecurityCenterManagement/src/V1/DeleteEventThreatDetectionCustomModuleRequest.php b/SecurityCenterManagement/src/V1/DeleteEventThreatDetectionCustomModuleRequest.php index 4f08f7d5180f..45fb939bb727 100644 --- a/SecurityCenterManagement/src/V1/DeleteEventThreatDetectionCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/DeleteEventThreatDetectionCustomModuleRequest.php @@ -9,44 +9,47 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Message for deleting a EventThreatDetectionCustomModule + * Request message for + * [SecurityCenterManagement.DeleteEventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.DeleteEventThreatDetectionCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.DeleteEventThreatDetectionCustomModuleRequest */ class DeleteEventThreatDetectionCustomModuleRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $name = ''; /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be deleted). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually delete the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be deleted. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to delete the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $validate_only = false; /** - * @param string $name Required. The resource name of the ETD custom module. + * @param string $name Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: * - * Its format is: - * - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. Please see - * {@see SecurityCenterManagementClient::eventThreatDetectionCustomModuleName()} for help formatting this field. + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * Please see {@see SecurityCenterManagementClient::eventThreatDetectionCustomModuleName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\DeleteEventThreatDetectionCustomModuleRequest * @@ -65,19 +68,22 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * @type bool $validate_only - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be deleted). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually delete the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be deleted. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to delete the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * } */ public function __construct($data = NULL) { @@ -86,11 +92,11 @@ public function __construct($data = NULL) { } /** - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -101,11 +107,11 @@ public function getName() } /** - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -120,13 +126,16 @@ public function setName($var) } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be deleted). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually delete the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be deleted. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to delete the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -137,13 +146,16 @@ public function getValidateOnly() } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be deleted). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually delete the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be deleted. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to delete the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/SecurityCenterManagement/src/V1/DeleteSecurityHealthAnalyticsCustomModuleRequest.php b/SecurityCenterManagement/src/V1/DeleteSecurityHealthAnalyticsCustomModuleRequest.php index ccb2146822e6..bfafbf5b60d2 100644 --- a/SecurityCenterManagement/src/V1/DeleteSecurityHealthAnalyticsCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/DeleteSecurityHealthAnalyticsCustomModuleRequest.php @@ -9,44 +9,47 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Message for deleting a SecurityHealthAnalyticsCustomModule + * Request message for + * [SecurityCenterManagement.DeleteSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.DeleteSecurityHealthAnalyticsCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.DeleteSecurityHealthAnalyticsCustomModuleRequest */ class DeleteSecurityHealthAnalyticsCustomModuleRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The resource name of the SHA custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. + * Required. The resource name of the SHA custom module, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $name = ''; /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be deleted). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually delete the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be deleted. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to delete the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during deletion of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $validate_only = false; /** - * @param string $name Required. The resource name of the SHA custom module. + * @param string $name Required. The resource name of the SHA custom module, in one of the + * following formats: * - * Its format is: - * - * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. Please see - * {@see SecurityCenterManagementClient::securityHealthAnalyticsCustomModuleName()} for help formatting this field. + * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * Please see {@see SecurityCenterManagementClient::securityHealthAnalyticsCustomModuleName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\DeleteSecurityHealthAnalyticsCustomModuleRequest * @@ -65,19 +68,22 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. The resource name of the SHA custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. + * Required. The resource name of the SHA custom module, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` * @type bool $validate_only - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be deleted). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually delete the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be deleted. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to delete the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during deletion of the module + * Defaults to `false`. * } */ public function __construct($data = NULL) { @@ -86,11 +92,11 @@ public function __construct($data = NULL) { } /** - * Required. The resource name of the SHA custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. + * Required. The resource name of the SHA custom module, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -101,11 +107,11 @@ public function getName() } /** - * Required. The resource name of the SHA custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. + * Required. The resource name of the SHA custom module, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -120,13 +126,16 @@ public function setName($var) } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be deleted). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually delete the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be deleted. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to delete the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during deletion of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -137,13 +146,16 @@ public function getValidateOnly() } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be deleted). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually delete the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be deleted. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to delete the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during deletion of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/SecurityCenterManagement/src/V1/EffectiveEventThreatDetectionCustomModule.php b/SecurityCenterManagement/src/V1/EffectiveEventThreatDetectionCustomModule.php index 659b3cd6a15e..ea107de94721 100644 --- a/SecurityCenterManagement/src/V1/EffectiveEventThreatDetectionCustomModule.php +++ b/SecurityCenterManagement/src/V1/EffectiveEventThreatDetectionCustomModule.php @@ -9,30 +9,30 @@ use Google\Protobuf\Internal\GPBUtil; /** - * An EffectiveEventThreatDetectionCustomModule is the representation of - * EventThreatDetectionCustomModule at a given level taking hierarchy into - * account and resolving various fields accordingly. e.g. if the module is - * enabled at the ancestor level, effective modules at all descendant levels - * will have enablement_state set to ENABLED. Similarly, if module.inherited is - * set, then effective module's config will contain the ancestor's config - * details. EffectiveEventThreatDetectionCustomModule is read-only. + * The representation of an + * [EventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule] + * at a given level, taking hierarchy into account and resolving various fields + * accordingly. For example, if the module is enabled at the ancestor level, + * then effective modules at all descendant levels will have their enablement + * state set to `ENABLED`. Similarly, if `module.inherited` is set, then the + * effective module's configuration will reflect the ancestor's configuration. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule */ class EffectiveEventThreatDetectionCustomModule extends \Google\Protobuf\Internal\Message { /** - * Identifier. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. + * Identifier. The resource name of the Event Threat Detection custom module, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; */ protected $name = ''; /** - * Output only. Config for the effective module. + * Output only. Configuration for the effective module. * * Generated from protobuf field .google.protobuf.Struct config = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ @@ -45,19 +45,19 @@ class EffectiveEventThreatDetectionCustomModule extends \Google\Protobuf\Interna */ protected $enablement_state = 0; /** - * Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP. + * Output only. Type for the module (for example, `CONFIGURABLE_BAD_IP`). * * Generated from protobuf field string type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $type = ''; /** - * Output only. The human readable name to be displayed for the module. + * Output only. The human-readable name of the module. * * Generated from protobuf field string display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $display_name = ''; /** - * Output only. The description for the module. + * Output only. A description of the module. * * Generated from protobuf field string description = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ @@ -70,22 +70,22 @@ class EffectiveEventThreatDetectionCustomModule extends \Google\Protobuf\Interna * Optional. Data for populating the Message object. * * @type string $name - * Identifier. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. + * Identifier. The resource name of the Event Threat Detection custom module, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` * @type \Google\Protobuf\Struct $config - * Output only. Config for the effective module. + * Output only. Configuration for the effective module. * @type int $enablement_state * Output only. The effective state of enablement for the module at the given * level of the hierarchy. * @type string $type - * Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP. + * Output only. Type for the module (for example, `CONFIGURABLE_BAD_IP`). * @type string $display_name - * Output only. The human readable name to be displayed for the module. + * Output only. The human-readable name of the module. * @type string $description - * Output only. The description for the module. + * Output only. A description of the module. * } */ public function __construct($data = NULL) { @@ -94,11 +94,11 @@ public function __construct($data = NULL) { } /** - * Identifier. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. + * Identifier. The resource name of the Event Threat Detection custom module, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @return string @@ -109,11 +109,11 @@ public function getName() } /** - * Identifier. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. + * Identifier. The resource name of the Event Threat Detection custom module, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @param string $var @@ -128,7 +128,7 @@ public function setName($var) } /** - * Output only. Config for the effective module. + * Output only. Configuration for the effective module. * * Generated from protobuf field .google.protobuf.Struct config = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Protobuf\Struct|null @@ -149,7 +149,7 @@ public function clearConfig() } /** - * Output only. Config for the effective module. + * Output only. Configuration for the effective module. * * Generated from protobuf field .google.protobuf.Struct config = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Protobuf\Struct $var @@ -192,7 +192,7 @@ public function setEnablementState($var) } /** - * Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP. + * Output only. Type for the module (for example, `CONFIGURABLE_BAD_IP`). * * Generated from protobuf field string type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return string @@ -203,7 +203,7 @@ public function getType() } /** - * Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP. + * Output only. Type for the module (for example, `CONFIGURABLE_BAD_IP`). * * Generated from protobuf field string type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param string $var @@ -218,7 +218,7 @@ public function setType($var) } /** - * Output only. The human readable name to be displayed for the module. + * Output only. The human-readable name of the module. * * Generated from protobuf field string display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return string @@ -229,7 +229,7 @@ public function getDisplayName() } /** - * Output only. The human readable name to be displayed for the module. + * Output only. The human-readable name of the module. * * Generated from protobuf field string display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param string $var @@ -244,7 +244,7 @@ public function setDisplayName($var) } /** - * Output only. The description for the module. + * Output only. A description of the module. * * Generated from protobuf field string description = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return string @@ -255,7 +255,7 @@ public function getDescription() } /** - * Output only. The description for the module. + * Output only. A description of the module. * * Generated from protobuf field string description = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/EffectiveEventThreatDetectionCustomModule/EnablementState.php b/SecurityCenterManagement/src/V1/EffectiveEventThreatDetectionCustomModule/EnablementState.php index 752123fcee50..051267e926ec 100644 --- a/SecurityCenterManagement/src/V1/EffectiveEventThreatDetectionCustomModule/EnablementState.php +++ b/SecurityCenterManagement/src/V1/EffectiveEventThreatDetectionCustomModule/EnablementState.php @@ -14,7 +14,7 @@ class EnablementState { /** - * Unspecified enablement state. + * Default value. This value is unused. * * Generated from protobuf enum ENABLEMENT_STATE_UNSPECIFIED = 0; */ diff --git a/SecurityCenterManagement/src/V1/EffectiveSecurityHealthAnalyticsCustomModule.php b/SecurityCenterManagement/src/V1/EffectiveSecurityHealthAnalyticsCustomModule.php index 1345238cbc2f..5172f9fffee4 100644 --- a/SecurityCenterManagement/src/V1/EffectiveSecurityHealthAnalyticsCustomModule.php +++ b/SecurityCenterManagement/src/V1/EffectiveSecurityHealthAnalyticsCustomModule.php @@ -9,26 +9,24 @@ use Google\Protobuf\Internal\GPBUtil; /** - * An EffectiveSecurityHealthAnalyticsCustomModule is the representation of - * a Security Health Analytics custom module at a specified level of the - * resource hierarchy: organization, folder, or project. If a custom module is - * inherited from a parent organization or folder, the value of the - * `enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule is - * set to the value that is effective in the parent, instead of `INHERITED`. - * For example, if the module is enabled in a parent organization or folder, the - * effective enablement_state for the module in all child folders or projects is - * also `enabled`. EffectiveSecurityHealthAnalyticsCustomModule is read-only. + * The representation of a Security Health Analytics custom module at a + * specified level of the resource hierarchy: organization, folder, or project. + * If a custom module is inherited from an ancestor organization or folder, then + * the enablement state is set to the value that is effective in the parent, not + * to `INHERITED`. For example, if the module is enabled in an organization or + * folder, then the effective enablement state for the module is `ENABLED` in + * all descendant folders or projects. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule */ class EffectiveSecurityHealthAnalyticsCustomModule extends \Google\Protobuf\Internal\Message { /** - * Identifier. The full resource name of the custom module, specified in one - * of the following formats: - * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` + * Identifier. The full resource name of the custom module, in one of the + * following formats: + * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; */ @@ -40,7 +38,7 @@ class EffectiveSecurityHealthAnalyticsCustomModule extends \Google\Protobuf\Inte */ protected $custom_config = null; /** - * Output only. The effective state of enablement for the module at the given + * Output only. The effective enablement state for the module at the given * level of the hierarchy. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; @@ -62,15 +60,15 @@ class EffectiveSecurityHealthAnalyticsCustomModule extends \Google\Protobuf\Inte * Optional. Data for populating the Message object. * * @type string $name - * Identifier. The full resource name of the custom module, specified in one - * of the following formats: - * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` + * Identifier. The full resource name of the custom module, in one of the + * following formats: + * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` * @type \Google\Cloud\SecurityCenterManagement\V1\CustomConfig $custom_config * Output only. The user-specified configuration for the module. * @type int $enablement_state - * Output only. The effective state of enablement for the module at the given + * Output only. The effective enablement state for the module at the given * level of the hierarchy. * @type string $display_name * Output only. The display name for the custom module. The name must be @@ -84,11 +82,11 @@ public function __construct($data = NULL) { } /** - * Identifier. The full resource name of the custom module, specified in one - * of the following formats: - * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` + * Identifier. The full resource name of the custom module, in one of the + * following formats: + * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @return string @@ -99,11 +97,11 @@ public function getName() } /** - * Identifier. The full resource name of the custom module, specified in one - * of the following formats: - * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` + * Identifier. The full resource name of the custom module, in one of the + * following formats: + * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @param string $var @@ -154,7 +152,7 @@ public function setCustomConfig($var) } /** - * Output only. The effective state of enablement for the module at the given + * Output only. The effective enablement state for the module at the given * level of the hierarchy. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; @@ -166,7 +164,7 @@ public function getEnablementState() } /** - * Output only. The effective state of enablement for the module at the given + * Output only. The effective enablement state for the module at the given * level of the hierarchy. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; diff --git a/SecurityCenterManagement/src/V1/EffectiveSecurityHealthAnalyticsCustomModule/EnablementState.php b/SecurityCenterManagement/src/V1/EffectiveSecurityHealthAnalyticsCustomModule/EnablementState.php index 4368999573f8..2e61f01d8de3 100644 --- a/SecurityCenterManagement/src/V1/EffectiveSecurityHealthAnalyticsCustomModule/EnablementState.php +++ b/SecurityCenterManagement/src/V1/EffectiveSecurityHealthAnalyticsCustomModule/EnablementState.php @@ -14,7 +14,7 @@ class EnablementState { /** - * Unspecified enablement state. + * Default value. This value is unused. * * Generated from protobuf enum ENABLEMENT_STATE_UNSPECIFIED = 0; */ diff --git a/SecurityCenterManagement/src/V1/EventThreatDetectionCustomModule.php b/SecurityCenterManagement/src/V1/EventThreatDetectionCustomModule.php index c6dc2492db74..4b5c0af7354a 100644 --- a/SecurityCenterManagement/src/V1/EventThreatDetectionCustomModule.php +++ b/SecurityCenterManagement/src/V1/EventThreatDetectionCustomModule.php @@ -9,28 +9,28 @@ use Google\Protobuf\Internal\GPBUtil; /** - * An event threat detection custom module is a Cloud SCC resource that contains - * the configuration and enablement state of a custom module, which enables ETD - * to write certain findings to Cloud SCC. + * A Security Command Center resource that contains the configuration and + * enablement state of a custom module, which enables Event Threat Detection to + * write certain findings to Security Command Center. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule */ class EventThreatDetectionCustomModule extends \Google\Protobuf\Internal\Message { /** - * Identifier. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Identifier. The resource name of the Event Threat Detection custom module, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; */ protected $name = ''; /** - * Optional. Config for the module. For the resident module, its config value - * is defined at this level. For the inherited module, its config value is - * inherited from the ancestor module. + * Optional. Configuration for the module. For the resident module, its + * configuration value is defined at this level. For the inherited module, its + * configuration value is inherited from the ancestor module. * * Generated from protobuf field .google.protobuf.Struct config = 2 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -39,7 +39,7 @@ class EventThreatDetectionCustomModule extends \Google\Protobuf\Internal\Message * Output only. The closest ancestor module that this module inherits the * enablement state from. If empty, indicates that the custom module was * created in the requesting parent organization, folder, or project. The - * format is the same as the EventThreatDetectionCustomModule resource name. + * format is the same as the custom module's resource name. * * Generated from protobuf field string ancestor_module = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { */ @@ -52,19 +52,19 @@ class EventThreatDetectionCustomModule extends \Google\Protobuf\Internal\Message */ protected $enablement_state = 0; /** - * Optional. Type for the module. e.g. CONFIGURABLE_BAD_IP. + * Optional. Type for the module. For example, `CONFIGURABLE_BAD_IP`. * * Generated from protobuf field string type = 5 [(.google.api.field_behavior) = OPTIONAL]; */ protected $type = ''; /** - * Optional. The human readable name to be displayed for the module. + * Optional. The human-readable name of the module. * * Generated from protobuf field string display_name = 6 [(.google.api.field_behavior) = OPTIONAL]; */ protected $display_name = ''; /** - * Optional. The description for the module. + * Optional. A description of the module. * * Generated from protobuf field string description = 7 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -89,29 +89,29 @@ class EventThreatDetectionCustomModule extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Identifier. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Identifier. The resource name of the Event Threat Detection custom module, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * @type \Google\Protobuf\Struct $config - * Optional. Config for the module. For the resident module, its config value - * is defined at this level. For the inherited module, its config value is - * inherited from the ancestor module. + * Optional. Configuration for the module. For the resident module, its + * configuration value is defined at this level. For the inherited module, its + * configuration value is inherited from the ancestor module. * @type string $ancestor_module * Output only. The closest ancestor module that this module inherits the * enablement state from. If empty, indicates that the custom module was * created in the requesting parent organization, folder, or project. The - * format is the same as the EventThreatDetectionCustomModule resource name. + * format is the same as the custom module's resource name. * @type int $enablement_state * Optional. The state of enablement for the module at the given level of the * hierarchy. * @type string $type - * Optional. Type for the module. e.g. CONFIGURABLE_BAD_IP. + * Optional. Type for the module. For example, `CONFIGURABLE_BAD_IP`. * @type string $display_name - * Optional. The human readable name to be displayed for the module. + * Optional. The human-readable name of the module. * @type string $description - * Optional. The description for the module. + * Optional. A description of the module. * @type \Google\Protobuf\Timestamp $update_time * Output only. The time the module was last updated. * @type string $last_editor @@ -124,11 +124,11 @@ public function __construct($data = NULL) { } /** - * Identifier. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Identifier. The resource name of the Event Threat Detection custom module, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @return string @@ -139,11 +139,11 @@ public function getName() } /** - * Identifier. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Identifier. The resource name of the Event Threat Detection custom module, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @param string $var @@ -158,9 +158,9 @@ public function setName($var) } /** - * Optional. Config for the module. For the resident module, its config value - * is defined at this level. For the inherited module, its config value is - * inherited from the ancestor module. + * Optional. Configuration for the module. For the resident module, its + * configuration value is defined at this level. For the inherited module, its + * configuration value is inherited from the ancestor module. * * Generated from protobuf field .google.protobuf.Struct config = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Struct|null @@ -181,9 +181,9 @@ public function clearConfig() } /** - * Optional. Config for the module. For the resident module, its config value - * is defined at this level. For the inherited module, its config value is - * inherited from the ancestor module. + * Optional. Configuration for the module. For the resident module, its + * configuration value is defined at this level. For the inherited module, its + * configuration value is inherited from the ancestor module. * * Generated from protobuf field .google.protobuf.Struct config = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Protobuf\Struct $var @@ -201,7 +201,7 @@ public function setConfig($var) * Output only. The closest ancestor module that this module inherits the * enablement state from. If empty, indicates that the custom module was * created in the requesting parent organization, folder, or project. The - * format is the same as the EventThreatDetectionCustomModule resource name. + * format is the same as the custom module's resource name. * * Generated from protobuf field string ancestor_module = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { * @return string @@ -215,7 +215,7 @@ public function getAncestorModule() * Output only. The closest ancestor module that this module inherits the * enablement state from. If empty, indicates that the custom module was * created in the requesting parent organization, folder, or project. The - * format is the same as the EventThreatDetectionCustomModule resource name. + * format is the same as the custom module's resource name. * * Generated from protobuf field string ancestor_module = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { * @param string $var @@ -258,7 +258,7 @@ public function setEnablementState($var) } /** - * Optional. Type for the module. e.g. CONFIGURABLE_BAD_IP. + * Optional. Type for the module. For example, `CONFIGURABLE_BAD_IP`. * * Generated from protobuf field string type = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -269,7 +269,7 @@ public function getType() } /** - * Optional. Type for the module. e.g. CONFIGURABLE_BAD_IP. + * Optional. Type for the module. For example, `CONFIGURABLE_BAD_IP`. * * Generated from protobuf field string type = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -284,7 +284,7 @@ public function setType($var) } /** - * Optional. The human readable name to be displayed for the module. + * Optional. The human-readable name of the module. * * Generated from protobuf field string display_name = 6 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -295,7 +295,7 @@ public function getDisplayName() } /** - * Optional. The human readable name to be displayed for the module. + * Optional. The human-readable name of the module. * * Generated from protobuf field string display_name = 6 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -310,7 +310,7 @@ public function setDisplayName($var) } /** - * Optional. The description for the module. + * Optional. A description of the module. * * Generated from protobuf field string description = 7 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -321,7 +321,7 @@ public function getDescription() } /** - * Optional. The description for the module. + * Optional. A description of the module. * * Generated from protobuf field string description = 7 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/EventThreatDetectionCustomModule/EnablementState.php b/SecurityCenterManagement/src/V1/EventThreatDetectionCustomModule/EnablementState.php index bfc3020182f3..8cff8c55d88a 100644 --- a/SecurityCenterManagement/src/V1/EventThreatDetectionCustomModule/EnablementState.php +++ b/SecurityCenterManagement/src/V1/EventThreatDetectionCustomModule/EnablementState.php @@ -32,11 +32,11 @@ class EnablementState */ const DISABLED = 2; /** - * State is inherited from an ancestor module. The module will either - * be effectively ENABLED or DISABLED based on its closest non-inherited - * ancestor module in the CRM hierarchy. Attempting to set a top level - * module (module with no parent) to the INHERITED state will result in an - * error. + * State is inherited from an ancestor module. The module will either be + * effectively `ENABLED` or `DISABLED` based on its closest non-inherited + * ancestor module in the CRM hierarchy. If you try to set a top-level + * module (a module with no parent) to the `INHERITED` state, you receive an + * `INVALID_ARGUMENT` error. * * Generated from protobuf enum INHERITED = 3; */ diff --git a/SecurityCenterManagement/src/V1/GetEffectiveEventThreatDetectionCustomModuleRequest.php b/SecurityCenterManagement/src/V1/GetEffectiveEventThreatDetectionCustomModuleRequest.php index 34bdee84cc97..cccd53442b4d 100644 --- a/SecurityCenterManagement/src/V1/GetEffectiveEventThreatDetectionCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/GetEffectiveEventThreatDetectionCustomModuleRequest.php @@ -9,32 +9,32 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Message for getting a EffectiveEventThreatDetectionCustomModule + * Request message for + * [SecurityCenterManagement.GetEffectiveEventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.GetEffectiveEventThreatDetectionCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.GetEffectiveEventThreatDetectionCustomModuleRequest */ class GetEffectiveEventThreatDetectionCustomModuleRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $name = ''; /** - * @param string $name Required. The resource name of the ETD custom module. + * @param string $name Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: * - * Its format is: - * - * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. Please see - * {@see SecurityCenterManagementClient::effectiveEventThreatDetectionCustomModuleName()} for help formatting this field. + * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * Please see {@see SecurityCenterManagementClient::effectiveEventThreatDetectionCustomModuleName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\GetEffectiveEventThreatDetectionCustomModuleRequest * @@ -53,11 +53,11 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` * } */ public function __construct($data = NULL) { @@ -66,11 +66,11 @@ public function __construct($data = NULL) { } /** - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -81,11 +81,11 @@ public function getName() } /** - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/SecurityCenterManagement/src/V1/GetEffectiveSecurityHealthAnalyticsCustomModuleRequest.php b/SecurityCenterManagement/src/V1/GetEffectiveSecurityHealthAnalyticsCustomModuleRequest.php index e784437bc70f..be05181a1559 100644 --- a/SecurityCenterManagement/src/V1/GetEffectiveSecurityHealthAnalyticsCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/GetEffectiveSecurityHealthAnalyticsCustomModuleRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Message for getting a EffectiveSecurityHealthAnalyticsCustomModule + * Request message for + * [SecurityCenterManagement.GetEffectiveSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.GetEffectiveSecurityHealthAnalyticsCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.GetEffectiveSecurityHealthAnalyticsCustomModuleRequest */ @@ -18,9 +19,9 @@ class GetEffectiveSecurityHealthAnalyticsCustomModuleRequest extends \Google\Pro /** * Required. The full resource name of the custom module, specified in one of * the following formats: - * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` + * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -30,9 +31,9 @@ class GetEffectiveSecurityHealthAnalyticsCustomModuleRequest extends \Google\Pro * @param string $name Required. The full resource name of the custom module, specified in one of * the following formats: * - * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` + * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` * Please see {@see SecurityCenterManagementClient::effectiveSecurityHealthAnalyticsCustomModuleName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\GetEffectiveSecurityHealthAnalyticsCustomModuleRequest @@ -54,9 +55,9 @@ public static function build(string $name): self * @type string $name * Required. The full resource name of the custom module, specified in one of * the following formats: - * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` + * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` * } */ public function __construct($data = NULL) { @@ -67,9 +68,9 @@ public function __construct($data = NULL) { /** * Required. The full resource name of the custom module, specified in one of * the following formats: - * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` + * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -82,9 +83,9 @@ public function getName() /** * Required. The full resource name of the custom module, specified in one of * the following formats: - * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` + * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/SecurityCenterManagement/src/V1/GetEventThreatDetectionCustomModuleRequest.php b/SecurityCenterManagement/src/V1/GetEventThreatDetectionCustomModuleRequest.php index e280d8f676fa..7a83d6b48561 100644 --- a/SecurityCenterManagement/src/V1/GetEventThreatDetectionCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/GetEventThreatDetectionCustomModuleRequest.php @@ -9,32 +9,32 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Message for getting a EventThreatDetectionCustomModule + * Request message for + * [SecurityCenterManagement.GetEventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.GetEventThreatDetectionCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.GetEventThreatDetectionCustomModuleRequest */ class GetEventThreatDetectionCustomModuleRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $name = ''; /** - * @param string $name Required. The resource name of the ETD custom module. + * @param string $name Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: * - * Its format is: - * - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. Please see - * {@see SecurityCenterManagementClient::eventThreatDetectionCustomModuleName()} for help formatting this field. + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * Please see {@see SecurityCenterManagementClient::eventThreatDetectionCustomModuleName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\GetEventThreatDetectionCustomModuleRequest * @@ -53,11 +53,11 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * } */ public function __construct($data = NULL) { @@ -66,11 +66,11 @@ public function __construct($data = NULL) { } /** - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -81,11 +81,11 @@ public function getName() } /** - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/SecurityCenterManagement/src/V1/GetSecurityCenterServiceRequest.php b/SecurityCenterManagement/src/V1/GetSecurityCenterServiceRequest.php index aafec1171fef..5edd59857e95 100644 --- a/SecurityCenterManagement/src/V1/GetSecurityCenterServiceRequest.php +++ b/SecurityCenterManagement/src/V1/GetSecurityCenterServiceRequest.php @@ -9,52 +9,52 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message for getting a Security Command Center service. + * Request message for + * [SecurityCenterManagement.GetSecurityCenterService][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.GetSecurityCenterService]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.GetSecurityCenterServiceRequest */ class GetSecurityCenterServiceRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The Security Command Center service to retrieve. - * Formats: - * * organizations/{organization}/locations/{location}/securityCenterServices/{service} - * * folders/{folder}/locations/{location}/securityCenterServices/{service} - * * projects/{project}/locations/{location}/securityCenterServices/{service} - * The possible values for id {service} are: - * * container-threat-detection - * * event-threat-detection - * * security-health-analytics - * * vm-threat-detection - * * web-security-scanner + * Required. The Security Command Center service to retrieve, in one of the + * following formats: + * * organizations/{organization}/locations/{location}/securityCenterServices/{service} + * * folders/{folder}/locations/{location}/securityCenterServices/{service} + * * projects/{project}/locations/{location}/securityCenterServices/{service} + * The following values are valid for `{service}`: + * * `container-threat-detection` + * * `event-threat-detection` + * * `security-health-analytics` + * * `vm-threat-detection` + * * `web-security-scanner` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $name = ''; /** - * Flag that, when set, will be used to filter the ModuleSettings that are - * in scope. The default setting is that all modules will be shown. + * Set to `true` to show only modules that are in scope. By default, all + * modules are shown. * * Generated from protobuf field bool show_eligible_modules_only = 2; */ protected $show_eligible_modules_only = false; /** - * @param string $name Required. The Security Command Center service to retrieve. - * - * Formats: + * @param string $name Required. The Security Command Center service to retrieve, in one of the + * following formats: * * * organizations/{organization}/locations/{location}/securityCenterServices/{service} * * folders/{folder}/locations/{location}/securityCenterServices/{service} * * projects/{project}/locations/{location}/securityCenterServices/{service} * - * The possible values for id {service} are: + * The following values are valid for `{service}`: * - * * container-threat-detection - * * event-threat-detection - * * security-health-analytics - * * vm-threat-detection - * * web-security-scanner + * * `container-threat-detection` + * * `event-threat-detection` + * * `security-health-analytics` + * * `vm-threat-detection` + * * `web-security-scanner` * Please see {@see SecurityCenterManagementClient::securityCenterServiceName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\GetSecurityCenterServiceRequest @@ -74,20 +74,20 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. The Security Command Center service to retrieve. - * Formats: - * * organizations/{organization}/locations/{location}/securityCenterServices/{service} - * * folders/{folder}/locations/{location}/securityCenterServices/{service} - * * projects/{project}/locations/{location}/securityCenterServices/{service} - * The possible values for id {service} are: - * * container-threat-detection - * * event-threat-detection - * * security-health-analytics - * * vm-threat-detection - * * web-security-scanner + * Required. The Security Command Center service to retrieve, in one of the + * following formats: + * * organizations/{organization}/locations/{location}/securityCenterServices/{service} + * * folders/{folder}/locations/{location}/securityCenterServices/{service} + * * projects/{project}/locations/{location}/securityCenterServices/{service} + * The following values are valid for `{service}`: + * * `container-threat-detection` + * * `event-threat-detection` + * * `security-health-analytics` + * * `vm-threat-detection` + * * `web-security-scanner` * @type bool $show_eligible_modules_only - * Flag that, when set, will be used to filter the ModuleSettings that are - * in scope. The default setting is that all modules will be shown. + * Set to `true` to show only modules that are in scope. By default, all + * modules are shown. * } */ public function __construct($data = NULL) { @@ -96,17 +96,17 @@ public function __construct($data = NULL) { } /** - * Required. The Security Command Center service to retrieve. - * Formats: - * * organizations/{organization}/locations/{location}/securityCenterServices/{service} - * * folders/{folder}/locations/{location}/securityCenterServices/{service} - * * projects/{project}/locations/{location}/securityCenterServices/{service} - * The possible values for id {service} are: - * * container-threat-detection - * * event-threat-detection - * * security-health-analytics - * * vm-threat-detection - * * web-security-scanner + * Required. The Security Command Center service to retrieve, in one of the + * following formats: + * * organizations/{organization}/locations/{location}/securityCenterServices/{service} + * * folders/{folder}/locations/{location}/securityCenterServices/{service} + * * projects/{project}/locations/{location}/securityCenterServices/{service} + * The following values are valid for `{service}`: + * * `container-threat-detection` + * * `event-threat-detection` + * * `security-health-analytics` + * * `vm-threat-detection` + * * `web-security-scanner` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -117,17 +117,17 @@ public function getName() } /** - * Required. The Security Command Center service to retrieve. - * Formats: - * * organizations/{organization}/locations/{location}/securityCenterServices/{service} - * * folders/{folder}/locations/{location}/securityCenterServices/{service} - * * projects/{project}/locations/{location}/securityCenterServices/{service} - * The possible values for id {service} are: - * * container-threat-detection - * * event-threat-detection - * * security-health-analytics - * * vm-threat-detection - * * web-security-scanner + * Required. The Security Command Center service to retrieve, in one of the + * following formats: + * * organizations/{organization}/locations/{location}/securityCenterServices/{service} + * * folders/{folder}/locations/{location}/securityCenterServices/{service} + * * projects/{project}/locations/{location}/securityCenterServices/{service} + * The following values are valid for `{service}`: + * * `container-threat-detection` + * * `event-threat-detection` + * * `security-health-analytics` + * * `vm-threat-detection` + * * `web-security-scanner` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -142,8 +142,8 @@ public function setName($var) } /** - * Flag that, when set, will be used to filter the ModuleSettings that are - * in scope. The default setting is that all modules will be shown. + * Set to `true` to show only modules that are in scope. By default, all + * modules are shown. * * Generated from protobuf field bool show_eligible_modules_only = 2; * @return bool @@ -154,8 +154,8 @@ public function getShowEligibleModulesOnly() } /** - * Flag that, when set, will be used to filter the ModuleSettings that are - * in scope. The default setting is that all modules will be shown. + * Set to `true` to show only modules that are in scope. By default, all + * modules are shown. * * Generated from protobuf field bool show_eligible_modules_only = 2; * @param bool $var diff --git a/SecurityCenterManagement/src/V1/GetSecurityHealthAnalyticsCustomModuleRequest.php b/SecurityCenterManagement/src/V1/GetSecurityHealthAnalyticsCustomModuleRequest.php index 5069157c7578..084370424dd4 100644 --- a/SecurityCenterManagement/src/V1/GetSecurityHealthAnalyticsCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/GetSecurityHealthAnalyticsCustomModuleRequest.php @@ -9,22 +9,25 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Message for getting a SecurityHealthAnalyticsCustomModule + * Request message for + * [SecurityCenterManagement.GetSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.GetSecurityHealthAnalyticsCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.GetSecurityHealthAnalyticsCustomModuleRequest */ class GetSecurityHealthAnalyticsCustomModuleRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Name of the resource + * Required. Name of the resource, in the format + * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $name = ''; /** - * @param string $name Required. Name of the resource - * Please see {@see SecurityCenterManagementClient::securityHealthAnalyticsCustomModuleName()} for help formatting this field. + * @param string $name Required. Name of the resource, in the format + * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`. Please see + * {@see SecurityCenterManagementClient::securityHealthAnalyticsCustomModuleName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\GetSecurityHealthAnalyticsCustomModuleRequest * @@ -43,7 +46,8 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. Name of the resource + * Required. Name of the resource, in the format + * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`. * } */ public function __construct($data = NULL) { @@ -52,7 +56,8 @@ public function __construct($data = NULL) { } /** - * Required. Name of the resource + * Required. Name of the resource, in the format + * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -63,7 +68,8 @@ public function getName() } /** - * Required. Name of the resource + * Required. Name of the resource, in the format + * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListDescendantEventThreatDetectionCustomModulesRequest.php b/SecurityCenterManagement/src/V1/ListDescendantEventThreatDetectionCustomModulesRequest.php index 6ea98488fc72..08df9dd9338b 100644 --- a/SecurityCenterManagement/src/V1/ListDescendantEventThreatDetectionCustomModulesRequest.php +++ b/SecurityCenterManagement/src/V1/ListDescendantEventThreatDetectionCustomModulesRequest.php @@ -9,19 +9,19 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message for listing descendant Event Threat Detection custom - * modules. + * Request message for + * [SecurityCenterManagement.ListDescendantEventThreatDetectionCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListDescendantEventThreatDetectionCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListDescendantEventThreatDetectionCustomModulesRequest */ class ListDescendantEventThreatDetectionCustomModulesRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list custom modules, in one of the following + * formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -35,18 +35,22 @@ class ListDescendantEventThreatDetectionCustomModulesRequest extends \Google\Pro */ protected $page_size = 0; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_token = ''; /** - * @param string $parent Required. Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * @param string $parent Required. Name of parent to list custom modules, in one of the following + * formats: + * + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\ListDescendantEventThreatDetectionCustomModulesRequest @@ -66,17 +70,20 @@ public static function build(string $parent): self * Optional. Data for populating the Message object. * * @type string $parent - * Required. Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list custom modules, in one of the following + * formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * @type int $page_size * Optional. The maximum number of modules to return. The service may return * fewer than this value. If unspecified, at most 10 configs will be returned. * The maximum value is 1000; values above 1000 will be coerced to 1000. * @type string $page_token - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * } */ public function __construct($data = NULL) { @@ -85,11 +92,11 @@ public function __construct($data = NULL) { } /** - * Required. Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list custom modules, in one of the following + * formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -100,11 +107,11 @@ public function getParent() } /** - * Required. Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list custom modules, in one of the following + * formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -149,7 +156,10 @@ public function setPageSize($var) } /** - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -160,7 +170,10 @@ public function getPageToken() } /** - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListDescendantEventThreatDetectionCustomModulesResponse.php b/SecurityCenterManagement/src/V1/ListDescendantEventThreatDetectionCustomModulesResponse.php index 91e329e5f403..d3724d98999f 100644 --- a/SecurityCenterManagement/src/V1/ListDescendantEventThreatDetectionCustomModulesResponse.php +++ b/SecurityCenterManagement/src/V1/ListDescendantEventThreatDetectionCustomModulesResponse.php @@ -9,21 +9,22 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Response message for listing descendant Event Threat Detection custom - * modules. + * Response message for + * [SecurityCenterManagement.ListDescendantEventThreatDetectionCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListDescendantEventThreatDetectionCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListDescendantEventThreatDetectionCustomModulesResponse */ class ListDescendantEventThreatDetectionCustomModulesResponse extends \Google\Protobuf\Internal\Message { /** - * The list of EventThreatDetectionCustomModules + * The list of custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_modules = 1; */ private $event_threat_detection_custom_modules; /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; */ @@ -36,9 +37,10 @@ class ListDescendantEventThreatDetectionCustomModulesResponse extends \Google\Pr * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule>|\Google\Protobuf\Internal\RepeatedField $event_threat_detection_custom_modules - * The list of EventThreatDetectionCustomModules + * The list of custom modules. * @type string $next_page_token - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * } */ public function __construct($data = NULL) { @@ -47,7 +49,7 @@ public function __construct($data = NULL) { } /** - * The list of EventThreatDetectionCustomModules + * The list of custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_modules = 1; * @return \Google\Protobuf\Internal\RepeatedField @@ -58,7 +60,7 @@ public function getEventThreatDetectionCustomModules() } /** - * The list of EventThreatDetectionCustomModules + * The list of custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_modules = 1; * @param array<\Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule>|\Google\Protobuf\Internal\RepeatedField $var @@ -73,7 +75,8 @@ public function setEventThreatDetectionCustomModules($var) } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @return string @@ -84,7 +87,8 @@ public function getNextPageToken() } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListDescendantSecurityHealthAnalyticsCustomModulesRequest.php b/SecurityCenterManagement/src/V1/ListDescendantSecurityHealthAnalyticsCustomModulesRequest.php index 4db8d6b92e86..04f451500490 100644 --- a/SecurityCenterManagement/src/V1/ListDescendantSecurityHealthAnalyticsCustomModulesRequest.php +++ b/SecurityCenterManagement/src/V1/ListDescendantSecurityHealthAnalyticsCustomModulesRequest.php @@ -9,8 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message for listing descendant Security Health Analytics custom - * modules. + * Request message for + * [SecurityCenterManagement.ListDescendantSecurityHealthAnalyticsCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListDescendantSecurityHealthAnalyticsCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListDescendantSecurityHealthAnalyticsCustomModulesRequest */ @@ -18,7 +18,7 @@ class ListDescendantSecurityHealthAnalyticsCustomModulesRequest extends \Google\ { /** * Required. Name of the parent organization, folder, or project in which to - * list custom modules, specified in one of the following formats: + * list custom modules, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -34,7 +34,10 @@ class ListDescendantSecurityHealthAnalyticsCustomModulesRequest extends \Google\ */ protected $page_size = 0; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -42,7 +45,7 @@ class ListDescendantSecurityHealthAnalyticsCustomModulesRequest extends \Google\ /** * @param string $parent Required. Name of the parent organization, folder, or project in which to - * list custom modules, specified in one of the following formats: + * list custom modules, in one of the following formats: * * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` @@ -67,7 +70,7 @@ public static function build(string $parent): self * * @type string $parent * Required. Name of the parent organization, folder, or project in which to - * list custom modules, specified in one of the following formats: + * list custom modules, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -75,7 +78,10 @@ public static function build(string $parent): self * Optional. The maximum number of results to return in a single response. * Default is 10, minimum is 1, maximum is 1000. * @type string $page_token - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * } */ public function __construct($data = NULL) { @@ -85,7 +91,7 @@ public function __construct($data = NULL) { /** * Required. Name of the parent organization, folder, or project in which to - * list custom modules, specified in one of the following formats: + * list custom modules, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -100,7 +106,7 @@ public function getParent() /** * Required. Name of the parent organization, folder, or project in which to - * list custom modules, specified in one of the following formats: + * list custom modules, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -146,7 +152,10 @@ public function setPageSize($var) } /** - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -157,7 +166,10 @@ public function getPageToken() } /** - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListDescendantSecurityHealthAnalyticsCustomModulesResponse.php b/SecurityCenterManagement/src/V1/ListDescendantSecurityHealthAnalyticsCustomModulesResponse.php index b28b46e3c747..478fa12d4ec0 100644 --- a/SecurityCenterManagement/src/V1/ListDescendantSecurityHealthAnalyticsCustomModulesResponse.php +++ b/SecurityCenterManagement/src/V1/ListDescendantSecurityHealthAnalyticsCustomModulesResponse.php @@ -9,8 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Response message for listing descendant Security Health Analytics custom - * modules. + * Response message for + * [SecurityCenterManagement.ListDescendantSecurityHealthAnalyticsCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListDescendantSecurityHealthAnalyticsCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListDescendantSecurityHealthAnalyticsCustomModulesResponse */ @@ -23,7 +23,8 @@ class ListDescendantSecurityHealthAnalyticsCustomModulesResponse extends \Google */ private $security_health_analytics_custom_modules; /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; */ @@ -38,7 +39,8 @@ class ListDescendantSecurityHealthAnalyticsCustomModulesResponse extends \Google * @type array<\Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule>|\Google\Protobuf\Internal\RepeatedField $security_health_analytics_custom_modules * The list of SecurityHealthAnalyticsCustomModules * @type string $next_page_token - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * } */ public function __construct($data = NULL) { @@ -73,7 +75,8 @@ public function setSecurityHealthAnalyticsCustomModules($var) } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @return string @@ -84,7 +87,8 @@ public function getNextPageToken() } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListEffectiveEventThreatDetectionCustomModulesRequest.php b/SecurityCenterManagement/src/V1/ListEffectiveEventThreatDetectionCustomModulesRequest.php index 40094fd46acf..e5bf147f21a0 100644 --- a/SecurityCenterManagement/src/V1/ListEffectiveEventThreatDetectionCustomModulesRequest.php +++ b/SecurityCenterManagement/src/V1/ListEffectiveEventThreatDetectionCustomModulesRequest.php @@ -9,19 +9,19 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message for listing effective Event Threat Detection custom - * modules. + * Request message for + * [SecurityCenterManagement.ListEffectiveEventThreatDetectionCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListEffectiveEventThreatDetectionCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListEffectiveEventThreatDetectionCustomModulesRequest */ class ListEffectiveEventThreatDetectionCustomModulesRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Name of parent to list effective custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list effective custom modules, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -34,18 +34,22 @@ class ListEffectiveEventThreatDetectionCustomModulesRequest extends \Google\Prot */ protected $page_size = 0; /** - * Optional. The value returned by the last call indicating a continuation + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_token = ''; /** - * @param string $parent Required. Name of parent to list effective custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * @param string $parent Required. Name of parent to list effective custom modules, in one of the + * following formats: + * + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\ListEffectiveEventThreatDetectionCustomModulesRequest @@ -65,16 +69,19 @@ public static function build(string $parent): self * Optional. Data for populating the Message object. * * @type string $parent - * Required. Name of parent to list effective custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list effective custom modules, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * @type int $page_size * Optional. The maximum number of results to return in a single response. * Default is 10, minimum is 1, maximum is 1000. * @type string $page_token - * Optional. The value returned by the last call indicating a continuation + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * } */ public function __construct($data = NULL) { @@ -83,11 +90,11 @@ public function __construct($data = NULL) { } /** - * Required. Name of parent to list effective custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list effective custom modules, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -98,11 +105,11 @@ public function getParent() } /** - * Required. Name of parent to list effective custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list effective custom modules, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -145,7 +152,10 @@ public function setPageSize($var) } /** - * Optional. The value returned by the last call indicating a continuation + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -156,7 +166,10 @@ public function getPageToken() } /** - * Optional. The value returned by the last call indicating a continuation + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListEffectiveEventThreatDetectionCustomModulesResponse.php b/SecurityCenterManagement/src/V1/ListEffectiveEventThreatDetectionCustomModulesResponse.php index 66317828ab95..e8bb16a7e9a4 100644 --- a/SecurityCenterManagement/src/V1/ListEffectiveEventThreatDetectionCustomModulesResponse.php +++ b/SecurityCenterManagement/src/V1/ListEffectiveEventThreatDetectionCustomModulesResponse.php @@ -9,21 +9,22 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Response message for listing effective Event Threat Detection custom - * modules. + * Response message for + * [SecurityCenterManagement.ListEffectiveEventThreatDetectionCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListEffectiveEventThreatDetectionCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListEffectiveEventThreatDetectionCustomModulesResponse */ class ListEffectiveEventThreatDetectionCustomModulesResponse extends \Google\Protobuf\Internal\Message { /** - * The list of EffectiveEventThreatDetectionCustomModules + * The list of effective Event Threat Detection custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule effective_event_threat_detection_custom_modules = 1; */ private $effective_event_threat_detection_custom_modules; /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; */ @@ -36,9 +37,10 @@ class ListEffectiveEventThreatDetectionCustomModulesResponse extends \Google\Pro * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\SecurityCenterManagement\V1\EffectiveEventThreatDetectionCustomModule>|\Google\Protobuf\Internal\RepeatedField $effective_event_threat_detection_custom_modules - * The list of EffectiveEventThreatDetectionCustomModules + * The list of effective Event Threat Detection custom modules. * @type string $next_page_token - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * } */ public function __construct($data = NULL) { @@ -47,7 +49,7 @@ public function __construct($data = NULL) { } /** - * The list of EffectiveEventThreatDetectionCustomModules + * The list of effective Event Threat Detection custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule effective_event_threat_detection_custom_modules = 1; * @return \Google\Protobuf\Internal\RepeatedField @@ -58,7 +60,7 @@ public function getEffectiveEventThreatDetectionCustomModules() } /** - * The list of EffectiveEventThreatDetectionCustomModules + * The list of effective Event Threat Detection custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule effective_event_threat_detection_custom_modules = 1; * @param array<\Google\Cloud\SecurityCenterManagement\V1\EffectiveEventThreatDetectionCustomModule>|\Google\Protobuf\Internal\RepeatedField $var @@ -73,7 +75,8 @@ public function setEffectiveEventThreatDetectionCustomModules($var) } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @return string @@ -84,7 +87,8 @@ public function getNextPageToken() } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListEffectiveSecurityHealthAnalyticsCustomModulesRequest.php b/SecurityCenterManagement/src/V1/ListEffectiveSecurityHealthAnalyticsCustomModulesRequest.php index 4e8e3f4aceaf..f5b12a20bc52 100644 --- a/SecurityCenterManagement/src/V1/ListEffectiveSecurityHealthAnalyticsCustomModulesRequest.php +++ b/SecurityCenterManagement/src/V1/ListEffectiveSecurityHealthAnalyticsCustomModulesRequest.php @@ -9,20 +9,19 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message for listing effective Security Health Analytics custom - * modules. + * Request message for + * [SecurityCenterManagement.ListEffectiveSecurityHealthAnalyticsCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListEffectiveSecurityHealthAnalyticsCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListEffectiveSecurityHealthAnalyticsCustomModulesRequest */ class ListEffectiveSecurityHealthAnalyticsCustomModulesRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Name of parent to list effective custom modules. specified in one - * of the following formats: + * Required. Name of parent to list effective custom modules, in one of the + * following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` - * or - * `projects/{project}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -35,19 +34,22 @@ class ListEffectiveSecurityHealthAnalyticsCustomModulesRequest extends \Google\P */ protected $page_size = 0; /** - * Optional. The value returned by the last call indicating a continuation. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_token = ''; /** - * @param string $parent Required. Name of parent to list effective custom modules. specified in one - * of the following formats: + * @param string $parent Required. Name of parent to list effective custom modules, in one of the + * following formats: + * * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` - * or - * `projects/{project}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\ListEffectiveSecurityHealthAnalyticsCustomModulesRequest @@ -67,17 +69,19 @@ public static function build(string $parent): self * Optional. Data for populating the Message object. * * @type string $parent - * Required. Name of parent to list effective custom modules. specified in one - * of the following formats: + * Required. Name of parent to list effective custom modules, in one of the + * following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` - * or - * `projects/{project}/locations/{location}` + * * `projects/{project}/locations/{location}` * @type int $page_size * Optional. The maximum number of results to return in a single response. * Default is 10, minimum is 1, maximum is 1000. * @type string $page_token - * Optional. The value returned by the last call indicating a continuation. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * } */ public function __construct($data = NULL) { @@ -86,12 +90,11 @@ public function __construct($data = NULL) { } /** - * Required. Name of parent to list effective custom modules. specified in one - * of the following formats: + * Required. Name of parent to list effective custom modules, in one of the + * following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` - * or - * `projects/{project}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -102,12 +105,11 @@ public function getParent() } /** - * Required. Name of parent to list effective custom modules. specified in one - * of the following formats: + * Required. Name of parent to list effective custom modules, in one of the + * following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` - * or - * `projects/{project}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -150,7 +152,10 @@ public function setPageSize($var) } /** - * Optional. The value returned by the last call indicating a continuation. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -161,7 +166,10 @@ public function getPageToken() } /** - * Optional. The value returned by the last call indicating a continuation. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListEffectiveSecurityHealthAnalyticsCustomModulesResponse.php b/SecurityCenterManagement/src/V1/ListEffectiveSecurityHealthAnalyticsCustomModulesResponse.php index 7a21fad782a9..23b7e7dd9346 100644 --- a/SecurityCenterManagement/src/V1/ListEffectiveSecurityHealthAnalyticsCustomModulesResponse.php +++ b/SecurityCenterManagement/src/V1/ListEffectiveSecurityHealthAnalyticsCustomModulesResponse.php @@ -9,21 +9,22 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Response message for listing effective Security Health Analytics custom - * modules. + * Response message for + * [SecurityCenterManagement.ListEffectiveSecurityHealthAnalyticsCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListEffectiveSecurityHealthAnalyticsCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListEffectiveSecurityHealthAnalyticsCustomModulesResponse */ class ListEffectiveSecurityHealthAnalyticsCustomModulesResponse extends \Google\Protobuf\Internal\Message { /** - * The list of EffectiveSecurityHealthAnalyticsCustomModule + * The list of effective Security Health Analytics custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule effective_security_health_analytics_custom_modules = 1; */ private $effective_security_health_analytics_custom_modules; /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; */ @@ -36,9 +37,10 @@ class ListEffectiveSecurityHealthAnalyticsCustomModulesResponse extends \Google\ * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\SecurityCenterManagement\V1\EffectiveSecurityHealthAnalyticsCustomModule>|\Google\Protobuf\Internal\RepeatedField $effective_security_health_analytics_custom_modules - * The list of EffectiveSecurityHealthAnalyticsCustomModule + * The list of effective Security Health Analytics custom modules. * @type string $next_page_token - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * } */ public function __construct($data = NULL) { @@ -47,7 +49,7 @@ public function __construct($data = NULL) { } /** - * The list of EffectiveSecurityHealthAnalyticsCustomModule + * The list of effective Security Health Analytics custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule effective_security_health_analytics_custom_modules = 1; * @return \Google\Protobuf\Internal\RepeatedField @@ -58,7 +60,7 @@ public function getEffectiveSecurityHealthAnalyticsCustomModules() } /** - * The list of EffectiveSecurityHealthAnalyticsCustomModule + * The list of effective Security Health Analytics custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule effective_security_health_analytics_custom_modules = 1; * @param array<\Google\Cloud\SecurityCenterManagement\V1\EffectiveSecurityHealthAnalyticsCustomModule>|\Google\Protobuf\Internal\RepeatedField $var @@ -73,7 +75,8 @@ public function setEffectiveSecurityHealthAnalyticsCustomModules($var) } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @return string @@ -84,7 +87,8 @@ public function getNextPageToken() } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListEventThreatDetectionCustomModulesRequest.php b/SecurityCenterManagement/src/V1/ListEventThreatDetectionCustomModulesRequest.php index 16e359448211..1156908e530f 100644 --- a/SecurityCenterManagement/src/V1/ListEventThreatDetectionCustomModulesRequest.php +++ b/SecurityCenterManagement/src/V1/ListEventThreatDetectionCustomModulesRequest.php @@ -9,48 +9,48 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message for listing Event Threat Detection custom modules. + * Request message for + * [SecurityCenterManagement.ListEventThreatDetectionCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListEventThreatDetectionCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListEventThreatDetectionCustomModulesRequest */ class ListEventThreatDetectionCustomModulesRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list custom modules, in one of the following + * formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $parent = ''; /** * Optional. The maximum number of modules to return. The service may return - * fewer than this value. If unspecified, at most 10 configs will be returned. + * fewer than this value. If unspecified, at most 10 modules will be returned. * The maximum value is 1000; values above 1000 will be coerced to 1000. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_size = 0; /** - * Optional. A page token, received from a previous - * `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the - * subsequent page. - * When paginating, all other parameters provided to - * `ListEventThreatDetectionCustomModules` must match the call that provided - * the page token. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_token = ''; /** - * @param string $parent Required. Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * @param string $parent Required. Name of parent to list custom modules, in one of the following + * formats: + * + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\ListEventThreatDetectionCustomModulesRequest @@ -70,22 +70,20 @@ public static function build(string $parent): self * Optional. Data for populating the Message object. * * @type string $parent - * Required. Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list custom modules, in one of the following + * formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * @type int $page_size * Optional. The maximum number of modules to return. The service may return - * fewer than this value. If unspecified, at most 10 configs will be returned. + * fewer than this value. If unspecified, at most 10 modules will be returned. * The maximum value is 1000; values above 1000 will be coerced to 1000. * @type string $page_token - * Optional. A page token, received from a previous - * `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the - * subsequent page. - * When paginating, all other parameters provided to - * `ListEventThreatDetectionCustomModules` must match the call that provided - * the page token. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * } */ public function __construct($data = NULL) { @@ -94,11 +92,11 @@ public function __construct($data = NULL) { } /** - * Required. Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list custom modules, in one of the following + * formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -109,11 +107,11 @@ public function getParent() } /** - * Required. Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list custom modules, in one of the following + * formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -129,7 +127,7 @@ public function setParent($var) /** * Optional. The maximum number of modules to return. The service may return - * fewer than this value. If unspecified, at most 10 configs will be returned. + * fewer than this value. If unspecified, at most 10 modules will be returned. * The maximum value is 1000; values above 1000 will be coerced to 1000. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; @@ -142,7 +140,7 @@ public function getPageSize() /** * Optional. The maximum number of modules to return. The service may return - * fewer than this value. If unspecified, at most 10 configs will be returned. + * fewer than this value. If unspecified, at most 10 modules will be returned. * The maximum value is 1000; values above 1000 will be coerced to 1000. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; @@ -158,12 +156,10 @@ public function setPageSize($var) } /** - * Optional. A page token, received from a previous - * `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the - * subsequent page. - * When paginating, all other parameters provided to - * `ListEventThreatDetectionCustomModules` must match the call that provided - * the page token. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -174,12 +170,10 @@ public function getPageToken() } /** - * Optional. A page token, received from a previous - * `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the - * subsequent page. - * When paginating, all other parameters provided to - * `ListEventThreatDetectionCustomModules` must match the call that provided - * the page token. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListEventThreatDetectionCustomModulesResponse.php b/SecurityCenterManagement/src/V1/ListEventThreatDetectionCustomModulesResponse.php index ee2dd6dd74e4..a538e84d65b8 100644 --- a/SecurityCenterManagement/src/V1/ListEventThreatDetectionCustomModulesResponse.php +++ b/SecurityCenterManagement/src/V1/ListEventThreatDetectionCustomModulesResponse.php @@ -9,20 +9,22 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Response message for listing Event Threat Detection custom modules. + * Response message for + * [SecurityCenterManagement.ListEventThreatDetectionCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListEventThreatDetectionCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListEventThreatDetectionCustomModulesResponse */ class ListEventThreatDetectionCustomModulesResponse extends \Google\Protobuf\Internal\Message { /** - * The list of EventThreatDetectionCustomModules + * The list of custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_modules = 1; */ private $event_threat_detection_custom_modules; /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; */ @@ -35,9 +37,10 @@ class ListEventThreatDetectionCustomModulesResponse extends \Google\Protobuf\Int * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule>|\Google\Protobuf\Internal\RepeatedField $event_threat_detection_custom_modules - * The list of EventThreatDetectionCustomModules + * The list of custom modules. * @type string $next_page_token - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * } */ public function __construct($data = NULL) { @@ -46,7 +49,7 @@ public function __construct($data = NULL) { } /** - * The list of EventThreatDetectionCustomModules + * The list of custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_modules = 1; * @return \Google\Protobuf\Internal\RepeatedField @@ -57,7 +60,7 @@ public function getEventThreatDetectionCustomModules() } /** - * The list of EventThreatDetectionCustomModules + * The list of custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_modules = 1; * @param array<\Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule>|\Google\Protobuf\Internal\RepeatedField $var @@ -72,7 +75,8 @@ public function setEventThreatDetectionCustomModules($var) } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @return string @@ -83,7 +87,8 @@ public function getNextPageToken() } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListSecurityCenterServicesRequest.php b/SecurityCenterManagement/src/V1/ListSecurityCenterServicesRequest.php index 19c23c940772..ddadcb066ea1 100644 --- a/SecurityCenterManagement/src/V1/ListSecurityCenterServicesRequest.php +++ b/SecurityCenterManagement/src/V1/ListSecurityCenterServicesRequest.php @@ -9,18 +9,19 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message for listing Security Command Center services. + * Request message for + * [SecurityCenterManagement.ListSecurityCenterServices][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListSecurityCenterServices]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListSecurityCenterServicesRequest */ class ListSecurityCenterServicesRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The name of the parent to list Security Command Center services. - * Formats: - * * organizations/{organization}/locations/{location} - * * folders/{folder}/locations/{location} - * * projects/{project}/locations/{location} + * Required. The name of the parent to list Security Command Center services, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -33,27 +34,29 @@ class ListSecurityCenterServicesRequest extends \Google\Protobuf\Internal\Messag */ protected $page_size = 0; /** - * Optional. The value returned by the last call indicating a continuation. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_token = ''; /** - * Flag that, when set, will be used to filter the ModuleSettings that are - * in scope. The default setting is that all modules will be shown. + * Flag that, when set, is used to filter the module settings that are shown. + * The default setting is that all modules are shown. * * Generated from protobuf field bool show_eligible_modules_only = 4; */ protected $show_eligible_modules_only = false; /** - * @param string $parent Required. The name of the parent to list Security Command Center services. + * @param string $parent Required. The name of the parent to list Security Command Center services, + * in one of the following formats: * - * Formats: - * - * * organizations/{organization}/locations/{location} - * * folders/{folder}/locations/{location} - * * projects/{project}/locations/{location} + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\ListSecurityCenterServicesRequest @@ -73,19 +76,22 @@ public static function build(string $parent): self * Optional. Data for populating the Message object. * * @type string $parent - * Required. The name of the parent to list Security Command Center services. - * Formats: - * * organizations/{organization}/locations/{location} - * * folders/{folder}/locations/{location} - * * projects/{project}/locations/{location} + * Required. The name of the parent to list Security Command Center services, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * @type int $page_size * Optional. The maximum number of results to return in a single response. * Default is 10, minimum is 1, maximum is 1000. * @type string $page_token - * Optional. The value returned by the last call indicating a continuation. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * @type bool $show_eligible_modules_only - * Flag that, when set, will be used to filter the ModuleSettings that are - * in scope. The default setting is that all modules will be shown. + * Flag that, when set, is used to filter the module settings that are shown. + * The default setting is that all modules are shown. * } */ public function __construct($data = NULL) { @@ -94,11 +100,11 @@ public function __construct($data = NULL) { } /** - * Required. The name of the parent to list Security Command Center services. - * Formats: - * * organizations/{organization}/locations/{location} - * * folders/{folder}/locations/{location} - * * projects/{project}/locations/{location} + * Required. The name of the parent to list Security Command Center services, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -109,11 +115,11 @@ public function getParent() } /** - * Required. The name of the parent to list Security Command Center services. - * Formats: - * * organizations/{organization}/locations/{location} - * * folders/{folder}/locations/{location} - * * projects/{project}/locations/{location} + * Required. The name of the parent to list Security Command Center services, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -156,7 +162,10 @@ public function setPageSize($var) } /** - * Optional. The value returned by the last call indicating a continuation. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -167,7 +176,10 @@ public function getPageToken() } /** - * Optional. The value returned by the last call indicating a continuation. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -182,8 +194,8 @@ public function setPageToken($var) } /** - * Flag that, when set, will be used to filter the ModuleSettings that are - * in scope. The default setting is that all modules will be shown. + * Flag that, when set, is used to filter the module settings that are shown. + * The default setting is that all modules are shown. * * Generated from protobuf field bool show_eligible_modules_only = 4; * @return bool @@ -194,8 +206,8 @@ public function getShowEligibleModulesOnly() } /** - * Flag that, when set, will be used to filter the ModuleSettings that are - * in scope. The default setting is that all modules will be shown. + * Flag that, when set, is used to filter the module settings that are shown. + * The default setting is that all modules are shown. * * Generated from protobuf field bool show_eligible_modules_only = 4; * @param bool $var diff --git a/SecurityCenterManagement/src/V1/ListSecurityCenterServicesResponse.php b/SecurityCenterManagement/src/V1/ListSecurityCenterServicesResponse.php index 772555d39002..d43ae1af6a2d 100644 --- a/SecurityCenterManagement/src/V1/ListSecurityCenterServicesResponse.php +++ b/SecurityCenterManagement/src/V1/ListSecurityCenterServicesResponse.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Response message for listing Security Command Center services. + * Response message for + * [SecurityCenterManagement.ListSecurityCenterServices][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListSecurityCenterServices]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListSecurityCenterServicesResponse */ @@ -22,7 +23,8 @@ class ListSecurityCenterServicesResponse extends \Google\Protobuf\Internal\Messa */ private $security_center_services; /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; */ @@ -37,7 +39,8 @@ class ListSecurityCenterServicesResponse extends \Google\Protobuf\Internal\Messa * @type array<\Google\Cloud\SecurityCenterManagement\V1\SecurityCenterService>|\Google\Protobuf\Internal\RepeatedField $security_center_services * The list of services. * @type string $next_page_token - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * } */ public function __construct($data = NULL) { @@ -72,7 +75,8 @@ public function setSecurityCenterServices($var) } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @return string @@ -83,7 +87,8 @@ public function getNextPageToken() } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListSecurityHealthAnalyticsCustomModulesRequest.php b/SecurityCenterManagement/src/V1/ListSecurityHealthAnalyticsCustomModulesRequest.php index 2e52af07903c..7cd5f1705a22 100644 --- a/SecurityCenterManagement/src/V1/ListSecurityHealthAnalyticsCustomModulesRequest.php +++ b/SecurityCenterManagement/src/V1/ListSecurityHealthAnalyticsCustomModulesRequest.php @@ -9,15 +9,16 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message for listing Security Health Analytics custom modules. + * Request message for + * [SecurityCenterManagement.ListSecurityHealthAnalyticsCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListSecurityHealthAnalyticsCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListSecurityHealthAnalyticsCustomModulesRequest */ class ListSecurityHealthAnalyticsCustomModulesRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Name of parent organization, folder, or project in which to list - * custom modules, specified in one of the following formats: + * Required. Name of the parent organization, folder, or project in which to + * list custom modules, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -33,15 +34,18 @@ class ListSecurityHealthAnalyticsCustomModulesRequest extends \Google\Protobuf\I */ protected $page_size = 0; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_token = ''; /** - * @param string $parent Required. Name of parent organization, folder, or project in which to list - * custom modules, specified in one of the following formats: + * @param string $parent Required. Name of the parent organization, folder, or project in which to + * list custom modules, in one of the following formats: * * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` @@ -65,8 +69,8 @@ public static function build(string $parent): self * Optional. Data for populating the Message object. * * @type string $parent - * Required. Name of parent organization, folder, or project in which to list - * custom modules, specified in one of the following formats: + * Required. Name of the parent organization, folder, or project in which to + * list custom modules, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -74,7 +78,10 @@ public static function build(string $parent): self * Optional. The maximum number of results to return in a single response. * Default is 10, minimum is 1, maximum is 1000. * @type string $page_token - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * } */ public function __construct($data = NULL) { @@ -83,8 +90,8 @@ public function __construct($data = NULL) { } /** - * Required. Name of parent organization, folder, or project in which to list - * custom modules, specified in one of the following formats: + * Required. Name of the parent organization, folder, or project in which to + * list custom modules, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -98,8 +105,8 @@ public function getParent() } /** - * Required. Name of parent organization, folder, or project in which to list - * custom modules, specified in one of the following formats: + * Required. Name of the parent organization, folder, or project in which to + * list custom modules, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -145,7 +152,10 @@ public function setPageSize($var) } /** - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -156,7 +166,10 @@ public function getPageToken() } /** - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListSecurityHealthAnalyticsCustomModulesResponse.php b/SecurityCenterManagement/src/V1/ListSecurityHealthAnalyticsCustomModulesResponse.php index 4ed6c5ea9a78..837acd25dacc 100644 --- a/SecurityCenterManagement/src/V1/ListSecurityHealthAnalyticsCustomModulesResponse.php +++ b/SecurityCenterManagement/src/V1/ListSecurityHealthAnalyticsCustomModulesResponse.php @@ -9,20 +9,22 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Response message for listing Security Health Analytics custom modules. + * Response message for + * [SecurityCenterManagement.ListSecurityHealthAnalyticsCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListSecurityHealthAnalyticsCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListSecurityHealthAnalyticsCustomModulesResponse */ class ListSecurityHealthAnalyticsCustomModulesResponse extends \Google\Protobuf\Internal\Message { /** - * The list of SecurityHealthAnalyticsCustomModules + * The list of Security Health Analytics custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule security_health_analytics_custom_modules = 1; */ private $security_health_analytics_custom_modules; /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; */ @@ -35,9 +37,10 @@ class ListSecurityHealthAnalyticsCustomModulesResponse extends \Google\Protobuf\ * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule>|\Google\Protobuf\Internal\RepeatedField $security_health_analytics_custom_modules - * The list of SecurityHealthAnalyticsCustomModules + * The list of Security Health Analytics custom modules. * @type string $next_page_token - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * } */ public function __construct($data = NULL) { @@ -46,7 +49,7 @@ public function __construct($data = NULL) { } /** - * The list of SecurityHealthAnalyticsCustomModules + * The list of Security Health Analytics custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule security_health_analytics_custom_modules = 1; * @return \Google\Protobuf\Internal\RepeatedField @@ -57,7 +60,7 @@ public function getSecurityHealthAnalyticsCustomModules() } /** - * The list of SecurityHealthAnalyticsCustomModules + * The list of Security Health Analytics custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule security_health_analytics_custom_modules = 1; * @param array<\Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule>|\Google\Protobuf\Internal\RepeatedField $var @@ -72,7 +75,8 @@ public function setSecurityHealthAnalyticsCustomModules($var) } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @return string @@ -83,7 +87,8 @@ public function getNextPageToken() } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @param string $var diff --git a/SecurityCenterManagement/src/V1/SecurityCenterService.php b/SecurityCenterManagement/src/V1/SecurityCenterService.php index 6482912da57a..8f6f0023b937 100644 --- a/SecurityCenterManagement/src/V1/SecurityCenterService.php +++ b/SecurityCenterManagement/src/V1/SecurityCenterService.php @@ -13,39 +13,38 @@ * settings information such as top-level enablement in addition to individual * module settings. Service settings can be configured at the organization, * folder, or project level. Service settings at the organization or folder - * level are inherited by those in child folders and projects. + * level are inherited by those in descendant folders and projects. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.SecurityCenterService */ class SecurityCenterService extends \Google\Protobuf\Internal\Message { /** - * Identifier. The name of the service. - * Its format is: - * * organizations/{organization}/locations/{location}/securityCenterServices/{service} - * * folders/{folder}/locations/{location}/securityCenterServices/{service} - * * projects/{project}/locations/{location}/securityCenterServices/{service} - * The possible values for id {service} are: - * * container-threat-detection - * * event-threat-detection - * * security-health-analytics - * * vm-threat-detection - * * web-security-scanner + * Identifier. The name of the service, in one of the following formats: + * * `organizations/{organization}/locations/{location}/securityCenterServices/{service}` + * * `folders/{folder}/locations/{location}/securityCenterServices/{service}` + * * `projects/{project}/locations/{location}/securityCenterServices/{service}` + * The following values are valid for `{service}`: + * * `container-threat-detection` + * * `event-threat-detection` + * * `security-health-analytics` + * * `vm-threat-detection` + * * `web-security-scanner` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; */ protected $name = ''; /** - * Optional. The intended state of enablement for the service at its level of - * the resource hierarchy. A DISABLED state will override all module - * enablement_states to DISABLED. + * Optional. The intended enablement state for the service at its level of the + * resource hierarchy. A `DISABLED` state will override all module enablement + * states to `DISABLED`. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState intended_enablement_state = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $intended_enablement_state = 0; /** * Output only. The effective enablement state for the service at its level of - * the resource hierarchy. If the intended state is set to INHERITED, the + * the resource hierarchy. If the intended state is set to `INHERITED`, the * effective state will be inherited from the enablement state of an ancestor. * This state may differ from the intended enablement state due to billing * eligibility or onboarding status. @@ -54,8 +53,8 @@ class SecurityCenterService extends \Google\Protobuf\Internal\Message */ protected $effective_enablement_state = 0; /** - * Optional. The configurations including the state of enablement for the - * service's different modules. The absence of a module in the map implies its + * Optional. The module configurations, including the enablement state for the + * service's modules. The absence of a module in the map implies that its * configuration is inherited from its parents. * * Generated from protobuf field map modules = 4 [(.google.api.field_behavior) = OPTIONAL]; @@ -63,14 +62,14 @@ class SecurityCenterService extends \Google\Protobuf\Internal\Message private $modules; /** * Output only. The time the service was last updated. This could be due to an - * explicit user update or due to a side effect of another system change such + * explicit user update or due to a side effect of another system change, such * as billing subscription expiry. * * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $update_time = null; /** - * Optional. Additional service specific configuration. Not all services will + * Optional. Additional service-specific configuration. Not all services will * utilize this field. * * Generated from protobuf field .google.protobuf.Struct service_config = 6 [(.google.api.field_behavior) = OPTIONAL]; @@ -84,37 +83,36 @@ class SecurityCenterService extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Identifier. The name of the service. - * Its format is: - * * organizations/{organization}/locations/{location}/securityCenterServices/{service} - * * folders/{folder}/locations/{location}/securityCenterServices/{service} - * * projects/{project}/locations/{location}/securityCenterServices/{service} - * The possible values for id {service} are: - * * container-threat-detection - * * event-threat-detection - * * security-health-analytics - * * vm-threat-detection - * * web-security-scanner + * Identifier. The name of the service, in one of the following formats: + * * `organizations/{organization}/locations/{location}/securityCenterServices/{service}` + * * `folders/{folder}/locations/{location}/securityCenterServices/{service}` + * * `projects/{project}/locations/{location}/securityCenterServices/{service}` + * The following values are valid for `{service}`: + * * `container-threat-detection` + * * `event-threat-detection` + * * `security-health-analytics` + * * `vm-threat-detection` + * * `web-security-scanner` * @type int $intended_enablement_state - * Optional. The intended state of enablement for the service at its level of - * the resource hierarchy. A DISABLED state will override all module - * enablement_states to DISABLED. + * Optional. The intended enablement state for the service at its level of the + * resource hierarchy. A `DISABLED` state will override all module enablement + * states to `DISABLED`. * @type int $effective_enablement_state * Output only. The effective enablement state for the service at its level of - * the resource hierarchy. If the intended state is set to INHERITED, the + * the resource hierarchy. If the intended state is set to `INHERITED`, the * effective state will be inherited from the enablement state of an ancestor. * This state may differ from the intended enablement state due to billing * eligibility or onboarding status. * @type array|\Google\Protobuf\Internal\MapField $modules - * Optional. The configurations including the state of enablement for the - * service's different modules. The absence of a module in the map implies its + * Optional. The module configurations, including the enablement state for the + * service's modules. The absence of a module in the map implies that its * configuration is inherited from its parents. * @type \Google\Protobuf\Timestamp $update_time * Output only. The time the service was last updated. This could be due to an - * explicit user update or due to a side effect of another system change such + * explicit user update or due to a side effect of another system change, such * as billing subscription expiry. * @type \Google\Protobuf\Struct $service_config - * Optional. Additional service specific configuration. Not all services will + * Optional. Additional service-specific configuration. Not all services will * utilize this field. * } */ @@ -124,17 +122,16 @@ public function __construct($data = NULL) { } /** - * Identifier. The name of the service. - * Its format is: - * * organizations/{organization}/locations/{location}/securityCenterServices/{service} - * * folders/{folder}/locations/{location}/securityCenterServices/{service} - * * projects/{project}/locations/{location}/securityCenterServices/{service} - * The possible values for id {service} are: - * * container-threat-detection - * * event-threat-detection - * * security-health-analytics - * * vm-threat-detection - * * web-security-scanner + * Identifier. The name of the service, in one of the following formats: + * * `organizations/{organization}/locations/{location}/securityCenterServices/{service}` + * * `folders/{folder}/locations/{location}/securityCenterServices/{service}` + * * `projects/{project}/locations/{location}/securityCenterServices/{service}` + * The following values are valid for `{service}`: + * * `container-threat-detection` + * * `event-threat-detection` + * * `security-health-analytics` + * * `vm-threat-detection` + * * `web-security-scanner` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @return string @@ -145,17 +142,16 @@ public function getName() } /** - * Identifier. The name of the service. - * Its format is: - * * organizations/{organization}/locations/{location}/securityCenterServices/{service} - * * folders/{folder}/locations/{location}/securityCenterServices/{service} - * * projects/{project}/locations/{location}/securityCenterServices/{service} - * The possible values for id {service} are: - * * container-threat-detection - * * event-threat-detection - * * security-health-analytics - * * vm-threat-detection - * * web-security-scanner + * Identifier. The name of the service, in one of the following formats: + * * `organizations/{organization}/locations/{location}/securityCenterServices/{service}` + * * `folders/{folder}/locations/{location}/securityCenterServices/{service}` + * * `projects/{project}/locations/{location}/securityCenterServices/{service}` + * The following values are valid for `{service}`: + * * `container-threat-detection` + * * `event-threat-detection` + * * `security-health-analytics` + * * `vm-threat-detection` + * * `web-security-scanner` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @param string $var @@ -170,9 +166,9 @@ public function setName($var) } /** - * Optional. The intended state of enablement for the service at its level of - * the resource hierarchy. A DISABLED state will override all module - * enablement_states to DISABLED. + * Optional. The intended enablement state for the service at its level of the + * resource hierarchy. A `DISABLED` state will override all module enablement + * states to `DISABLED`. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState intended_enablement_state = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int @@ -183,9 +179,9 @@ public function getIntendedEnablementState() } /** - * Optional. The intended state of enablement for the service at its level of - * the resource hierarchy. A DISABLED state will override all module - * enablement_states to DISABLED. + * Optional. The intended enablement state for the service at its level of the + * resource hierarchy. A `DISABLED` state will override all module enablement + * states to `DISABLED`. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState intended_enablement_state = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var @@ -201,7 +197,7 @@ public function setIntendedEnablementState($var) /** * Output only. The effective enablement state for the service at its level of - * the resource hierarchy. If the intended state is set to INHERITED, the + * the resource hierarchy. If the intended state is set to `INHERITED`, the * effective state will be inherited from the enablement state of an ancestor. * This state may differ from the intended enablement state due to billing * eligibility or onboarding status. @@ -216,7 +212,7 @@ public function getEffectiveEnablementState() /** * Output only. The effective enablement state for the service at its level of - * the resource hierarchy. If the intended state is set to INHERITED, the + * the resource hierarchy. If the intended state is set to `INHERITED`, the * effective state will be inherited from the enablement state of an ancestor. * This state may differ from the intended enablement state due to billing * eligibility or onboarding status. @@ -234,8 +230,8 @@ public function setEffectiveEnablementState($var) } /** - * Optional. The configurations including the state of enablement for the - * service's different modules. The absence of a module in the map implies its + * Optional. The module configurations, including the enablement state for the + * service's modules. The absence of a module in the map implies that its * configuration is inherited from its parents. * * Generated from protobuf field map modules = 4 [(.google.api.field_behavior) = OPTIONAL]; @@ -247,8 +243,8 @@ public function getModules() } /** - * Optional. The configurations including the state of enablement for the - * service's different modules. The absence of a module in the map implies its + * Optional. The module configurations, including the enablement state for the + * service's modules. The absence of a module in the map implies that its * configuration is inherited from its parents. * * Generated from protobuf field map modules = 4 [(.google.api.field_behavior) = OPTIONAL]; @@ -265,7 +261,7 @@ public function setModules($var) /** * Output only. The time the service was last updated. This could be due to an - * explicit user update or due to a side effect of another system change such + * explicit user update or due to a side effect of another system change, such * as billing subscription expiry. * * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; @@ -288,7 +284,7 @@ public function clearUpdateTime() /** * Output only. The time the service was last updated. This could be due to an - * explicit user update or due to a side effect of another system change such + * explicit user update or due to a side effect of another system change, such * as billing subscription expiry. * * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; @@ -304,7 +300,7 @@ public function setUpdateTime($var) } /** - * Optional. Additional service specific configuration. Not all services will + * Optional. Additional service-specific configuration. Not all services will * utilize this field. * * Generated from protobuf field .google.protobuf.Struct service_config = 6 [(.google.api.field_behavior) = OPTIONAL]; @@ -326,7 +322,7 @@ public function clearServiceConfig() } /** - * Optional. Additional service specific configuration. Not all services will + * Optional. Additional service-specific configuration. Not all services will * utilize this field. * * Generated from protobuf field .google.protobuf.Struct service_config = 6 [(.google.api.field_behavior) = OPTIONAL]; diff --git a/SecurityCenterManagement/src/V1/SecurityCenterService/EnablementState.php b/SecurityCenterManagement/src/V1/SecurityCenterService/EnablementState.php index ec0c84ff61e9..ad2a197f3909 100644 --- a/SecurityCenterManagement/src/V1/SecurityCenterService/EnablementState.php +++ b/SecurityCenterManagement/src/V1/SecurityCenterService/EnablementState.php @@ -7,8 +7,7 @@ use UnexpectedValueException; /** - * Represents the possible intended states of enablement for a service or - * module. + * Represents the possible enablement states for a service or module. * * Protobuf type google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState */ @@ -21,8 +20,8 @@ class EnablementState */ const ENABLEMENT_STATE_UNSPECIFIED = 0; /** - * State is inherited from the parent resource. Not a valid effective - * enablement state. + * State is inherited from the parent resource. Valid as an intended + * enablement state, but not as an effective enablement state. * * Generated from protobuf enum INHERITED = 1; */ @@ -40,9 +39,10 @@ class EnablementState */ const DISABLED = 3; /** - * SCC is configured to ingest findings from this service but not enable - * this service. Not a valid intended_enablement_state (that is, this is a - * readonly state). + * Security Command Center is configured to ingest findings from this + * service, but not to enable this service. This state indicates that + * Security Command Center is misconfigured. You can't set this state + * yourself. * * Generated from protobuf enum INGEST_ONLY = 4; */ diff --git a/SecurityCenterManagement/src/V1/SecurityCenterService/ModuleSettings.php b/SecurityCenterManagement/src/V1/SecurityCenterService/ModuleSettings.php index 7b603e767c13..dd54816b3a55 100644 --- a/SecurityCenterManagement/src/V1/SecurityCenterService/ModuleSettings.php +++ b/SecurityCenterManagement/src/V1/SecurityCenterService/ModuleSettings.php @@ -16,7 +16,7 @@ class ModuleSettings extends \Google\Protobuf\Internal\Message { /** - * Optional. The intended state of enablement for the module at its level of + * Optional. The intended enablement state for the module at its level of * the resource hierarchy. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState intended_enablement_state = 1 [(.google.api.field_behavior) = OPTIONAL]; @@ -24,11 +24,10 @@ class ModuleSettings extends \Google\Protobuf\Internal\Message protected $intended_enablement_state = 0; /** * Output only. The effective enablement state for the module at its level - * of the resource hierarchy. If the intended state is set to INHERITED, the - * effective state will be inherited from the enablement state of an - * ancestor. This state may - * differ from the intended enablement state due to billing eligibility or - * onboarding status. + * of the resource hierarchy. If the intended state is set to `INHERITED`, + * the effective state will be inherited from the enablement state of an + * ancestor. This state may differ from the intended enablement state due to + * billing eligibility or onboarding status. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState effective_enablement_state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ @@ -41,15 +40,14 @@ class ModuleSettings extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type int $intended_enablement_state - * Optional. The intended state of enablement for the module at its level of + * Optional. The intended enablement state for the module at its level of * the resource hierarchy. * @type int $effective_enablement_state * Output only. The effective enablement state for the module at its level - * of the resource hierarchy. If the intended state is set to INHERITED, the - * effective state will be inherited from the enablement state of an - * ancestor. This state may - * differ from the intended enablement state due to billing eligibility or - * onboarding status. + * of the resource hierarchy. If the intended state is set to `INHERITED`, + * the effective state will be inherited from the enablement state of an + * ancestor. This state may differ from the intended enablement state due to + * billing eligibility or onboarding status. * } */ public function __construct($data = NULL) { @@ -58,7 +56,7 @@ public function __construct($data = NULL) { } /** - * Optional. The intended state of enablement for the module at its level of + * Optional. The intended enablement state for the module at its level of * the resource hierarchy. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState intended_enablement_state = 1 [(.google.api.field_behavior) = OPTIONAL]; @@ -70,7 +68,7 @@ public function getIntendedEnablementState() } /** - * Optional. The intended state of enablement for the module at its level of + * Optional. The intended enablement state for the module at its level of * the resource hierarchy. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState intended_enablement_state = 1 [(.google.api.field_behavior) = OPTIONAL]; @@ -87,11 +85,10 @@ public function setIntendedEnablementState($var) /** * Output only. The effective enablement state for the module at its level - * of the resource hierarchy. If the intended state is set to INHERITED, the - * effective state will be inherited from the enablement state of an - * ancestor. This state may - * differ from the intended enablement state due to billing eligibility or - * onboarding status. + * of the resource hierarchy. If the intended state is set to `INHERITED`, + * the effective state will be inherited from the enablement state of an + * ancestor. This state may differ from the intended enablement state due to + * billing eligibility or onboarding status. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState effective_enablement_state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return int @@ -103,11 +100,10 @@ public function getEffectiveEnablementState() /** * Output only. The effective enablement state for the module at its level - * of the resource hierarchy. If the intended state is set to INHERITED, the - * effective state will be inherited from the enablement state of an - * ancestor. This state may - * differ from the intended enablement state due to billing eligibility or - * onboarding status. + * of the resource hierarchy. If the intended state is set to `INHERITED`, + * the effective state will be inherited from the enablement state of an + * ancestor. This state may differ from the intended enablement state due to + * billing eligibility or onboarding status. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState effective_enablement_state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param int $var diff --git a/SecurityCenterManagement/src/V1/SecurityHealthAnalyticsCustomModule.php b/SecurityCenterManagement/src/V1/SecurityHealthAnalyticsCustomModule.php index db568064f325..540fd6a49456 100644 --- a/SecurityCenterManagement/src/V1/SecurityHealthAnalyticsCustomModule.php +++ b/SecurityCenterManagement/src/V1/SecurityHealthAnalyticsCustomModule.php @@ -13,18 +13,18 @@ * including its full module name, display name, enablement state, and last * updated time. You can create a custom module at the organization, folder, or * project level. Custom modules that you create at the organization or folder - * level are inherited by the child folders and projects. + * level are inherited by the descendant folders and projects. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule */ class SecurityHealthAnalyticsCustomModule extends \Google\Protobuf\Internal\Message { /** - * Identifier. The full resource name of the custom module, specified in one - * of the following formats: - * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` - * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` - * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` + * Identifier. The full resource name of the custom module, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; */ @@ -32,8 +32,8 @@ class SecurityHealthAnalyticsCustomModule extends \Google\Protobuf\Internal\Mess /** * Optional. The display name of the Security Health Analytics custom module. * This display name becomes the finding category for all findings that are - * returned by this custom module. The display name must be between 1 and - * 128 characters, start with a lowercase letter, and contain alphanumeric + * returned by this custom module. The display name must be between 1 and 128 + * characters, start with a lowercase letter, and contain alphanumeric * characters or underscores only. * * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OPTIONAL]; @@ -67,7 +67,7 @@ class SecurityHealthAnalyticsCustomModule extends \Google\Protobuf\Internal\Mess */ protected $ancestor_module = ''; /** - * Optional. The user specified custom configuration for the module. + * Optional. The user-specified custom configuration for the module. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.CustomConfig custom_config = 7 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -80,16 +80,16 @@ class SecurityHealthAnalyticsCustomModule extends \Google\Protobuf\Internal\Mess * Optional. Data for populating the Message object. * * @type string $name - * Identifier. The full resource name of the custom module, specified in one - * of the following formats: - * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` - * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` - * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` + * Identifier. The full resource name of the custom module, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` * @type string $display_name * Optional. The display name of the Security Health Analytics custom module. * This display name becomes the finding category for all findings that are - * returned by this custom module. The display name must be between 1 and - * 128 characters, start with a lowercase letter, and contain alphanumeric + * returned by this custom module. The display name must be between 1 and 128 + * characters, start with a lowercase letter, and contain alphanumeric * characters or underscores only. * @type int $enablement_state * Optional. The enablement state of the custom module. @@ -103,7 +103,7 @@ class SecurityHealthAnalyticsCustomModule extends \Google\Protobuf\Internal\Mess * in the organization, folder, or project in which you are viewing the custom * module. * @type \Google\Cloud\SecurityCenterManagement\V1\CustomConfig $custom_config - * Optional. The user specified custom configuration for the module. + * Optional. The user-specified custom configuration for the module. * } */ public function __construct($data = NULL) { @@ -112,11 +112,11 @@ public function __construct($data = NULL) { } /** - * Identifier. The full resource name of the custom module, specified in one - * of the following formats: - * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` - * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` - * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` + * Identifier. The full resource name of the custom module, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @return string @@ -127,11 +127,11 @@ public function getName() } /** - * Identifier. The full resource name of the custom module, specified in one - * of the following formats: - * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` - * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` - * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` + * Identifier. The full resource name of the custom module, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @param string $var @@ -148,8 +148,8 @@ public function setName($var) /** * Optional. The display name of the Security Health Analytics custom module. * This display name becomes the finding category for all findings that are - * returned by this custom module. The display name must be between 1 and - * 128 characters, start with a lowercase letter, and contain alphanumeric + * returned by this custom module. The display name must be between 1 and 128 + * characters, start with a lowercase letter, and contain alphanumeric * characters or underscores only. * * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OPTIONAL]; @@ -163,8 +163,8 @@ public function getDisplayName() /** * Optional. The display name of the Security Health Analytics custom module. * This display name becomes the finding category for all findings that are - * returned by this custom module. The display name must be between 1 and - * 128 characters, start with a lowercase letter, and contain alphanumeric + * returned by this custom module. The display name must be between 1 and 128 + * characters, start with a lowercase letter, and contain alphanumeric * characters or underscores only. * * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OPTIONAL]; @@ -300,7 +300,7 @@ public function setAncestorModule($var) } /** - * Optional. The user specified custom configuration for the module. + * Optional. The user-specified custom configuration for the module. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.CustomConfig custom_config = 7 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\SecurityCenterManagement\V1\CustomConfig|null @@ -321,7 +321,7 @@ public function clearCustomConfig() } /** - * Optional. The user specified custom configuration for the module. + * Optional. The user-specified custom configuration for the module. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.CustomConfig custom_config = 7 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\SecurityCenterManagement\V1\CustomConfig $var diff --git a/SecurityCenterManagement/src/V1/SecurityHealthAnalyticsCustomModule/EnablementState.php b/SecurityCenterManagement/src/V1/SecurityHealthAnalyticsCustomModule/EnablementState.php index 2933b0039b33..ccfeefae7cb0 100644 --- a/SecurityCenterManagement/src/V1/SecurityHealthAnalyticsCustomModule/EnablementState.php +++ b/SecurityCenterManagement/src/V1/SecurityHealthAnalyticsCustomModule/EnablementState.php @@ -14,29 +14,29 @@ class EnablementState { /** - * Unspecified enablement state. + * Default value. This value is unused. * * Generated from protobuf enum ENABLEMENT_STATE_UNSPECIFIED = 0; */ const ENABLEMENT_STATE_UNSPECIFIED = 0; /** - * The module is enabled at the given CRM resource. + * The module is enabled at the given organization, folder, or project. * * Generated from protobuf enum ENABLED = 1; */ const ENABLED = 1; /** - * The module is disabled at the given CRM resource. + * The module is disabled at the given organization, folder, or project. * * Generated from protobuf enum DISABLED = 2; */ const DISABLED = 2; /** * State is inherited from an ancestor module. The module will either - * be effectively ENABLED or DISABLED based on its closest non-inherited - * ancestor module in the CRM hierarchy. Attempting to set a top level - * module (module with no parent) to the INHERITED state will result in an - * INVALID_ARGUMENT error. + * be effectively `ENABLED` or `DISABLED` based on its closest non-inherited + * ancestor module in the resource hierarchy. If you try to set a top-level + * module (a module with no parent) to the `INHERITED` state, you receive an + * `INVALID_ARGUMENT` error. * * Generated from protobuf enum INHERITED = 3; */ diff --git a/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest.php b/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest.php index b7c4bdddc09b..dafdb842b8d7 100644 --- a/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest.php @@ -9,8 +9,9 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message to simulate a CustomConfig against a given test resource. - * Maximum size of the request is 4 MB by default. + * Request message for + * [SecurityCenterManagement.SimulateSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.SimulateSecurityHealthAnalyticsCustomModule]. + * The maximum size of the request is 4 MiB. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.SimulateSecurityHealthAnalyticsCustomModuleRequest */ @@ -18,10 +19,9 @@ class SimulateSecurityHealthAnalyticsCustomModuleRequest extends \Google\Protobu { /** * Required. The relative resource name of the organization, project, or - * 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}`. + * folder. For more information about relative resource names, see [AIP-122: + * Resource names](https://google.aip.dev/122). Example: + * `organizations/{organization_id}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; */ @@ -41,10 +41,9 @@ class SimulateSecurityHealthAnalyticsCustomModuleRequest extends \Google\Protobu /** * @param string $parent Required. The relative resource name of the organization, project, or - * 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}`. + * folder. For more information about relative resource names, see [AIP-122: + * Resource names](https://google.aip.dev/122). Example: + * `organizations/{organization_id}`. * @param \Google\Cloud\SecurityCenterManagement\V1\CustomConfig $customConfig Required. The custom configuration that you need to test. * @param \Google\Cloud\SecurityCenterManagement\V1\SimulateSecurityHealthAnalyticsCustomModuleRequest\SimulatedResource $resource Required. Resource data to simulate custom module against. * @@ -68,10 +67,9 @@ public static function build(string $parent, \Google\Cloud\SecurityCenterManagem * * @type string $parent * Required. The relative resource name of the organization, project, or - * 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}`. + * folder. For more information about relative resource names, see [AIP-122: + * Resource names](https://google.aip.dev/122). Example: + * `organizations/{organization_id}`. * @type \Google\Cloud\SecurityCenterManagement\V1\CustomConfig $custom_config * Required. The custom configuration that you need to test. * @type \Google\Cloud\SecurityCenterManagement\V1\SimulateSecurityHealthAnalyticsCustomModuleRequest\SimulatedResource $resource @@ -85,10 +83,9 @@ public function __construct($data = NULL) { /** * Required. The relative resource name of the organization, project, or - * 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}`. + * folder. For more information about relative resource names, see [AIP-122: + * Resource names](https://google.aip.dev/122). Example: + * `organizations/{organization_id}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; * @return string @@ -100,10 +97,9 @@ public function getParent() /** * Required. The relative resource name of the organization, project, or - * 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}`. + * folder. For more information about relative resource names, see [AIP-122: + * Resource names](https://google.aip.dev/122). Example: + * `organizations/{organization_id}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest/SimulatedResource.php b/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest/SimulatedResource.php index bd1fe46f93fb..5abdfa461c91 100644 --- a/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest/SimulatedResource.php +++ b/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest/SimulatedResource.php @@ -9,16 +9,14 @@ use Google\Protobuf\Internal\GPBUtil; /** - * 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. + * Manually constructed information about a resource. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.SimulateSecurityHealthAnalyticsCustomModuleRequest.SimulatedResource */ class SimulatedResource extends \Google\Protobuf\Internal\Message { /** - * Required. The type of the resource, for example, + * Required. The type of the resource. For example, * `compute.googleapis.com/Disk`. * * Generated from protobuf field string resource_type = 1 [(.google.api.field_behavior) = REQUIRED]; @@ -27,12 +25,16 @@ class SimulatedResource extends \Google\Protobuf\Internal\Message /** * Optional. A representation of the Google Cloud resource. Should match the * Google Cloud resource JSON format. + * If the custom module evaluates only the IAM allow policy, then you can + * omit this field. * * Generated from protobuf field .google.protobuf.Struct resource_data = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $resource_data = null; /** - * Optional. A representation of the IAM policy. + * Optional. A representation of the IAM allow policy. + * If the custom module evaluates only the resource data, then you can omit + * this field. * * Generated from protobuf field .google.iam.v1.Policy iam_policy_data = 3 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -45,13 +47,17 @@ class SimulatedResource extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $resource_type - * Required. The type of the resource, for example, + * Required. The type of the resource. For example, * `compute.googleapis.com/Disk`. * @type \Google\Protobuf\Struct $resource_data * Optional. A representation of the Google Cloud resource. Should match the * Google Cloud resource JSON format. + * If the custom module evaluates only the IAM allow policy, then you can + * omit this field. * @type \Google\Cloud\Iam\V1\Policy $iam_policy_data - * Optional. A representation of the IAM policy. + * Optional. A representation of the IAM allow policy. + * If the custom module evaluates only the resource data, then you can omit + * this field. * } */ public function __construct($data = NULL) { @@ -60,7 +66,7 @@ public function __construct($data = NULL) { } /** - * Required. The type of the resource, for example, + * Required. The type of the resource. For example, * `compute.googleapis.com/Disk`. * * Generated from protobuf field string resource_type = 1 [(.google.api.field_behavior) = REQUIRED]; @@ -72,7 +78,7 @@ public function getResourceType() } /** - * Required. The type of the resource, for example, + * Required. The type of the resource. For example, * `compute.googleapis.com/Disk`. * * Generated from protobuf field string resource_type = 1 [(.google.api.field_behavior) = REQUIRED]; @@ -90,6 +96,8 @@ public function setResourceType($var) /** * Optional. A representation of the Google Cloud resource. Should match the * Google Cloud resource JSON format. + * If the custom module evaluates only the IAM allow policy, then you can + * omit this field. * * Generated from protobuf field .google.protobuf.Struct resource_data = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Struct|null @@ -112,6 +120,8 @@ public function clearResourceData() /** * Optional. A representation of the Google Cloud resource. Should match the * Google Cloud resource JSON format. + * If the custom module evaluates only the IAM allow policy, then you can + * omit this field. * * Generated from protobuf field .google.protobuf.Struct resource_data = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Protobuf\Struct $var @@ -126,7 +136,9 @@ public function setResourceData($var) } /** - * Optional. A representation of the IAM policy. + * Optional. A representation of the IAM allow policy. + * If the custom module evaluates only the resource data, then you can omit + * this field. * * Generated from protobuf field .google.iam.v1.Policy iam_policy_data = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\Iam\V1\Policy|null @@ -147,7 +159,9 @@ public function clearIamPolicyData() } /** - * Optional. A representation of the IAM policy. + * Optional. A representation of the IAM allow policy. + * If the custom module evaluates only the resource data, then you can omit + * this field. * * Generated from protobuf field .google.iam.v1.Policy iam_policy_data = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\Iam\V1\Policy $var diff --git a/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleResponse.php b/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleResponse.php index 4e49642f855f..a9196e92dba8 100644 --- a/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleResponse.php +++ b/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleResponse.php @@ -9,8 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Response message for simulating a `SecurityHealthAnalyticsCustomModule` - * against a given resource. + * Response message for + * [SecurityCenterManagement.SimulateSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.SimulateSecurityHealthAnalyticsCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.SimulateSecurityHealthAnalyticsCustomModuleResponse */ diff --git a/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleResponse/SimulatedResult.php b/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleResponse/SimulatedResult.php index 9b2130dc3d95..9c43df356593 100644 --- a/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleResponse/SimulatedResult.php +++ b/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleResponse/SimulatedResult.php @@ -24,8 +24,8 @@ class SimulatedResult extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Cloud\SecurityCenterManagement\V1\SimulatedFinding $finding - * Finding that would be published for the test case, - * if a violation is detected. + * Finding that would be published for the test case if a violation is + * detected. * @type \Google\Protobuf\GPBEmpty $no_violation * Indicates that the test case does not trigger any violation. * @type \Google\Rpc\Status $error @@ -38,8 +38,8 @@ public function __construct($data = NULL) { } /** - * Finding that would be published for the test case, - * if a violation is detected. + * Finding that would be published for the test case if a violation is + * detected. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SimulatedFinding finding = 1; * @return \Google\Cloud\SecurityCenterManagement\V1\SimulatedFinding|null @@ -55,8 +55,8 @@ public function hasFinding() } /** - * Finding that would be published for the test case, - * if a violation is detected. + * Finding that would be published for the test case if a violation is + * detected. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SimulatedFinding finding = 1; * @param \Google\Cloud\SecurityCenterManagement\V1\SimulatedFinding $var diff --git a/SecurityCenterManagement/src/V1/SimulatedFinding.php b/SecurityCenterManagement/src/V1/SimulatedFinding.php index 4ca02b40dcf3..50199d68d4fb 100644 --- a/SecurityCenterManagement/src/V1/SimulatedFinding.php +++ b/SecurityCenterManagement/src/V1/SimulatedFinding.php @@ -9,49 +9,46 @@ use Google\Protobuf\Internal\GPBUtil; /** - * A subset of the fields of the Security Center Finding proto. The minimum set - * of fields needed to represent a simulated finding from a SHA custom module. + * The minimum set of fields needed to represent a simulated finding from a + * Security Health Analytics custom module. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.SimulatedFinding */ class SimulatedFinding extends \Google\Protobuf\Internal\Message { /** - * Identifier. The [relative resource - * name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) - * of the finding. Example: - * `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, - * `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, - * `projects/{project_id}/sources/{source_id}/findings/{finding_id}`. + * Identifier. The [relative resource name](https://google.aip.dev/122) of the + * finding, in one of the following formats: + * * `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` + * * `folders/{folder_id}/sources/{source_id}/findings/{finding_id}` + * * `projects/{project_id}/sources/{source_id}/findings/{finding_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; */ protected $name = ''; /** - * The relative resource name of the source the finding belongs to. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * This field is immutable after creation time. - * For example: - * `organizations/{organization_id}/sources/{source_id}` + * The [relative resource name](https://google.aip.dev/122) of the source the + * finding belongs to. For example, + * `organizations/{organization_id}/sources/{source_id}`. This field is + * immutable after creation time. * * Generated from protobuf field string parent = 2; */ protected $parent = ''; /** - * For findings on Google Cloud resources, the full resource - * name of the Google Cloud resource this finding is for. See: - * https://cloud.google.com/apis/design/resource_names#full_resource_name - * When the finding is for a non-Google Cloud resource, the resourceName can - * be a customer or partner defined string. This field is immutable after - * creation time. + * For findings on Google Cloud resources, the + * [full resource name](https://google.aip.dev/122#full-resource-names) of the + * Google Cloud resource this finding is for. When the finding is for a + * non-Google Cloud resource, the value can be a customer or partner defined + * string. This field is immutable after creation time. * * Generated from protobuf field string resource_name = 3; */ protected $resource_name = ''; /** - * The additional taxonomy group within findings from a given source. - * This field is immutable after creation time. - * Example: "XSS_FLASH_INJECTION" + * The additional taxonomy group within findings from a given source. For + * example, `XSS_FLASH_INJECTION`. This field is immutable after creation + * time. * * Generated from protobuf field string category = 4; */ @@ -63,22 +60,23 @@ class SimulatedFinding extends \Google\Protobuf\Internal\Message */ protected $state = 0; /** - * Source specific properties. These properties are managed by the source - * that writes the finding. The key names in the source_properties map must be - * between 1 and 255 characters, and must start with a letter and contain - * alphanumeric characters or underscores only. + * Source-specific properties. These properties are managed by the source + * that writes the finding. The key names must be between 1 and 255 + * characters; they must start with a letter and contain alphanumeric + * characters or underscores only. * * Generated from protobuf field map source_properties = 6; */ private $source_properties; /** * The time the finding was first detected. If an existing finding is updated, - * then this is the time the update occurred. + * then this is the time the update occurred. If the finding is later + * resolved, then this time reflects when the finding was resolved. * For example, if the finding represents an open firewall, this property * captures the time the detector believes the firewall became open. The - * accuracy is determined by the detector. If the finding is later resolved, - * then this time reflects when the finding was resolved. This must not - * be set to a value greater than the current timestamp. + * accuracy is determined by the detector. + * The event time must not be set to a value greater than the current + * timestamp. * * Generated from protobuf field .google.protobuf.Timestamp event_time = 7; */ @@ -104,44 +102,42 @@ class SimulatedFinding extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Identifier. The [relative resource - * name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) - * of the finding. Example: - * `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, - * `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, - * `projects/{project_id}/sources/{source_id}/findings/{finding_id}`. + * Identifier. The [relative resource name](https://google.aip.dev/122) of the + * finding, in one of the following formats: + * * `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` + * * `folders/{folder_id}/sources/{source_id}/findings/{finding_id}` + * * `projects/{project_id}/sources/{source_id}/findings/{finding_id}` * @type string $parent - * The relative resource name of the source the finding belongs to. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * This field is immutable after creation time. - * For example: - * `organizations/{organization_id}/sources/{source_id}` + * The [relative resource name](https://google.aip.dev/122) of the source the + * finding belongs to. For example, + * `organizations/{organization_id}/sources/{source_id}`. This field is + * immutable after creation time. * @type string $resource_name - * For findings on Google Cloud resources, the full resource - * name of the Google Cloud resource this finding is for. See: - * https://cloud.google.com/apis/design/resource_names#full_resource_name - * When the finding is for a non-Google Cloud resource, the resourceName can - * be a customer or partner defined string. This field is immutable after - * creation time. + * For findings on Google Cloud resources, the + * [full resource name](https://google.aip.dev/122#full-resource-names) of the + * Google Cloud resource this finding is for. When the finding is for a + * non-Google Cloud resource, the value can be a customer or partner defined + * string. This field is immutable after creation time. * @type string $category - * The additional taxonomy group within findings from a given source. - * This field is immutable after creation time. - * Example: "XSS_FLASH_INJECTION" + * The additional taxonomy group within findings from a given source. For + * example, `XSS_FLASH_INJECTION`. This field is immutable after creation + * time. * @type int $state * Output only. The state of the finding. * @type array|\Google\Protobuf\Internal\MapField $source_properties - * Source specific properties. These properties are managed by the source - * that writes the finding. The key names in the source_properties map must be - * between 1 and 255 characters, and must start with a letter and contain - * alphanumeric characters or underscores only. + * Source-specific properties. These properties are managed by the source + * that writes the finding. The key names must be between 1 and 255 + * characters; they must start with a letter and contain alphanumeric + * characters or underscores only. * @type \Google\Protobuf\Timestamp $event_time * The time the finding was first detected. If an existing finding is updated, - * then this is the time the update occurred. + * then this is the time the update occurred. If the finding is later + * resolved, then this time reflects when the finding was resolved. * For example, if the finding represents an open firewall, this property * captures the time the detector believes the firewall became open. The - * accuracy is determined by the detector. If the finding is later resolved, - * then this time reflects when the finding was resolved. This must not - * be set to a value greater than the current timestamp. + * accuracy is determined by the detector. + * The event time must not be set to a value greater than the current + * timestamp. * @type int $severity * The severity of the finding. This field is managed by the source that * writes the finding. @@ -155,12 +151,11 @@ public function __construct($data = NULL) { } /** - * Identifier. The [relative resource - * name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) - * of the finding. Example: - * `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, - * `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, - * `projects/{project_id}/sources/{source_id}/findings/{finding_id}`. + * Identifier. The [relative resource name](https://google.aip.dev/122) of the + * finding, in one of the following formats: + * * `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` + * * `folders/{folder_id}/sources/{source_id}/findings/{finding_id}` + * * `projects/{project_id}/sources/{source_id}/findings/{finding_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @return string @@ -171,12 +166,11 @@ public function getName() } /** - * Identifier. The [relative resource - * name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) - * of the finding. Example: - * `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, - * `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, - * `projects/{project_id}/sources/{source_id}/findings/{finding_id}`. + * Identifier. The [relative resource name](https://google.aip.dev/122) of the + * finding, in one of the following formats: + * * `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` + * * `folders/{folder_id}/sources/{source_id}/findings/{finding_id}` + * * `projects/{project_id}/sources/{source_id}/findings/{finding_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @param string $var @@ -191,11 +185,10 @@ public function setName($var) } /** - * The relative resource name of the source the finding belongs to. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * This field is immutable after creation time. - * For example: - * `organizations/{organization_id}/sources/{source_id}` + * The [relative resource name](https://google.aip.dev/122) of the source the + * finding belongs to. For example, + * `organizations/{organization_id}/sources/{source_id}`. This field is + * immutable after creation time. * * Generated from protobuf field string parent = 2; * @return string @@ -206,11 +199,10 @@ public function getParent() } /** - * The relative resource name of the source the finding belongs to. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * This field is immutable after creation time. - * For example: - * `organizations/{organization_id}/sources/{source_id}` + * The [relative resource name](https://google.aip.dev/122) of the source the + * finding belongs to. For example, + * `organizations/{organization_id}/sources/{source_id}`. This field is + * immutable after creation time. * * Generated from protobuf field string parent = 2; * @param string $var @@ -225,12 +217,11 @@ public function setParent($var) } /** - * For findings on Google Cloud resources, the full resource - * name of the Google Cloud resource this finding is for. See: - * https://cloud.google.com/apis/design/resource_names#full_resource_name - * When the finding is for a non-Google Cloud resource, the resourceName can - * be a customer or partner defined string. This field is immutable after - * creation time. + * For findings on Google Cloud resources, the + * [full resource name](https://google.aip.dev/122#full-resource-names) of the + * Google Cloud resource this finding is for. When the finding is for a + * non-Google Cloud resource, the value can be a customer or partner defined + * string. This field is immutable after creation time. * * Generated from protobuf field string resource_name = 3; * @return string @@ -241,12 +232,11 @@ public function getResourceName() } /** - * For findings on Google Cloud resources, the full resource - * name of the Google Cloud resource this finding is for. See: - * https://cloud.google.com/apis/design/resource_names#full_resource_name - * When the finding is for a non-Google Cloud resource, the resourceName can - * be a customer or partner defined string. This field is immutable after - * creation time. + * For findings on Google Cloud resources, the + * [full resource name](https://google.aip.dev/122#full-resource-names) of the + * Google Cloud resource this finding is for. When the finding is for a + * non-Google Cloud resource, the value can be a customer or partner defined + * string. This field is immutable after creation time. * * Generated from protobuf field string resource_name = 3; * @param string $var @@ -261,9 +251,9 @@ public function setResourceName($var) } /** - * The additional taxonomy group within findings from a given source. - * This field is immutable after creation time. - * Example: "XSS_FLASH_INJECTION" + * The additional taxonomy group within findings from a given source. For + * example, `XSS_FLASH_INJECTION`. This field is immutable after creation + * time. * * Generated from protobuf field string category = 4; * @return string @@ -274,9 +264,9 @@ public function getCategory() } /** - * The additional taxonomy group within findings from a given source. - * This field is immutable after creation time. - * Example: "XSS_FLASH_INJECTION" + * The additional taxonomy group within findings from a given source. For + * example, `XSS_FLASH_INJECTION`. This field is immutable after creation + * time. * * Generated from protobuf field string category = 4; * @param string $var @@ -317,10 +307,10 @@ public function setState($var) } /** - * Source specific properties. These properties are managed by the source - * that writes the finding. The key names in the source_properties map must be - * between 1 and 255 characters, and must start with a letter and contain - * alphanumeric characters or underscores only. + * Source-specific properties. These properties are managed by the source + * that writes the finding. The key names must be between 1 and 255 + * characters; they must start with a letter and contain alphanumeric + * characters or underscores only. * * Generated from protobuf field map source_properties = 6; * @return \Google\Protobuf\Internal\MapField @@ -331,10 +321,10 @@ public function getSourceProperties() } /** - * Source specific properties. These properties are managed by the source - * that writes the finding. The key names in the source_properties map must be - * between 1 and 255 characters, and must start with a letter and contain - * alphanumeric characters or underscores only. + * Source-specific properties. These properties are managed by the source + * that writes the finding. The key names must be between 1 and 255 + * characters; they must start with a letter and contain alphanumeric + * characters or underscores only. * * Generated from protobuf field map source_properties = 6; * @param array|\Google\Protobuf\Internal\MapField $var @@ -350,12 +340,13 @@ public function setSourceProperties($var) /** * The time the finding was first detected. If an existing finding is updated, - * then this is the time the update occurred. + * then this is the time the update occurred. If the finding is later + * resolved, then this time reflects when the finding was resolved. * For example, if the finding represents an open firewall, this property * captures the time the detector believes the firewall became open. The - * accuracy is determined by the detector. If the finding is later resolved, - * then this time reflects when the finding was resolved. This must not - * be set to a value greater than the current timestamp. + * accuracy is determined by the detector. + * The event time must not be set to a value greater than the current + * timestamp. * * Generated from protobuf field .google.protobuf.Timestamp event_time = 7; * @return \Google\Protobuf\Timestamp|null @@ -377,12 +368,13 @@ public function clearEventTime() /** * The time the finding was first detected. If an existing finding is updated, - * then this is the time the update occurred. + * then this is the time the update occurred. If the finding is later + * resolved, then this time reflects when the finding was resolved. * For example, if the finding represents an open firewall, this property * captures the time the detector believes the firewall became open. The - * accuracy is determined by the detector. If the finding is later resolved, - * then this time reflects when the finding was resolved. This must not - * be set to a value greater than the current timestamp. + * accuracy is determined by the detector. + * The event time must not be set to a value greater than the current + * timestamp. * * Generated from protobuf field .google.protobuf.Timestamp event_time = 7; * @param \Google\Protobuf\Timestamp $var diff --git a/SecurityCenterManagement/src/V1/SimulatedFinding/FindingClass.php b/SecurityCenterManagement/src/V1/SimulatedFinding/FindingClass.php index bbbf233602ea..e3e3f84b1b7a 100644 --- a/SecurityCenterManagement/src/V1/SimulatedFinding/FindingClass.php +++ b/SecurityCenterManagement/src/V1/SimulatedFinding/FindingClass.php @@ -7,14 +7,14 @@ use UnexpectedValueException; /** - * Represents what kind of Finding it is. + * Represents what kind of finding it is. * * Protobuf type google.cloud.securitycentermanagement.v1.SimulatedFinding.FindingClass */ class FindingClass { /** - * Unspecified finding class. + * Default value. This value is unused. * * Generated from protobuf enum FINDING_CLASS_UNSPECIFIED = 0; */ @@ -27,14 +27,14 @@ class FindingClass const THREAT = 1; /** * Describes a potential weakness in software that increases risk to - * Confidentiality & Integrity & Availability. + * confidentiality, integrity, and availability. * * Generated from protobuf enum VULNERABILITY = 2; */ const VULNERABILITY = 2; /** - * Describes a potential weakness in cloud resource/asset configuration that - * increases risk. + * Describes a potential weakness in cloud resource or asset configuration + * that increases risk. * * Generated from protobuf enum MISCONFIGURATION = 3; */ @@ -46,7 +46,8 @@ class FindingClass */ const OBSERVATION = 4; /** - * Describes an error that prevents some SCC functionality. + * Describes an error that prevents Security Command Center from working + * correctly. * * Generated from protobuf enum SCC_ERROR = 5; */ diff --git a/SecurityCenterManagement/src/V1/SimulatedFinding/Severity.php b/SecurityCenterManagement/src/V1/SimulatedFinding/Severity.php index d2317ee7fcfb..31db2d89923b 100644 --- a/SecurityCenterManagement/src/V1/SimulatedFinding/Severity.php +++ b/SecurityCenterManagement/src/V1/SimulatedFinding/Severity.php @@ -14,69 +14,63 @@ class Severity { /** - * This value is used for findings when a source doesn't write a severity - * value. + * Default value. This value is unused. * * Generated from protobuf enum SEVERITY_UNSPECIFIED = 0; */ const SEVERITY_UNSPECIFIED = 0; /** - * Vulnerability: - * A critical vulnerability is easily discoverable by an external actor, - * exploitable, and results in the direct ability to execute arbitrary code, - * exfiltrate data, and otherwise gain additional access and privileges to - * cloud resources and workloads. Examples include publicly accessible - * unprotected user data and public SSH access with weak or no - * passwords. - * Threat: - * Indicates a threat that is able to access, modify, or delete data or - * execute unauthorized code within existing resources. + * For vulnerabilities: A critical vulnerability is easily discoverable by + * an external actor, exploitable, and results in the direct ability to + * execute arbitrary code, exfiltrate data, and otherwise gain additional + * access and privileges to cloud resources and workloads. Examples include + * publicly accessible unprotected user data and public SSH access with weak + * or no passwords. + * For threats: Indicates a threat that is able to access, modify, or delete + * data or execute unauthorized code within existing resources. * * Generated from protobuf enum CRITICAL = 1; */ const CRITICAL = 1; /** - * Vulnerability: - * A high risk vulnerability can be easily discovered and exploited in - * combination with other vulnerabilities in order to gain direct access and - * the ability to execute arbitrary code, exfiltrate data, and otherwise - * gain additional access and privileges to cloud resources and workloads. - * An example is a database with weak or no passwords that is only - * accessible internally. This database could easily be compromised by an - * actor that had access to the internal network. - * Threat: - * Indicates a threat that is able to create new computational resources in - * an environment but not able to access data or execute code in existing - * resources. + * For vulnerabilities: A high-risk vulnerability can be easily discovered + * and exploited in combination with other vulnerabilities in order to gain + * direct access and the ability to execute arbitrary code, exfiltrate data, + * and otherwise gain additional access and privileges to cloud resources + * and workloads. An example is a database with weak or no passwords that is + * only accessible internally. This database could easily be compromised by + * an actor that had access to the internal network. + * For threats: Indicates a threat that is able to create new computational + * resources in an environment but not able to access data or execute code + * in existing resources. * * Generated from protobuf enum HIGH = 2; */ const HIGH = 2; /** - * Vulnerability: - * A medium risk vulnerability could be used by an actor to gain access to - * resources or privileges that enable them to eventually (through multiple - * steps or a complex exploit) gain access and the ability to execute - * arbitrary code or exfiltrate data. An example is a service account with - * access to more projects than it should have. If an actor gains access to - * the service account, they could potentially use that access to manipulate - * a project the service account was not intended to. - * Threat: - * Indicates a threat that is able to cause operational impact but may not - * access data or execute unauthorized code. + * For vulnerabilities: A medium-risk vulnerability could be used by an + * actor to gain access to resources or privileges that enable them to + * eventually (through multiple steps or a complex exploit) gain access and + * the ability to execute arbitrary code or exfiltrate data. An example is a + * service account with access to more projects than it should have. If an + * actor gains access to the service account, they could potentially use + * that access to manipulate a project the service account was not intended + * to. + * For threats: Indicates a threat that is able to cause operational impact + * but may not access data or execute unauthorized code. * * Generated from protobuf enum MEDIUM = 3; */ const MEDIUM = 3; /** - * Vulnerability: - * A low risk vulnerability hampers a security organization's ability to - * detect vulnerabilities or active threats in their deployment, or prevents - * the root cause investigation of security issues. An example is monitoring - * and logs being disabled for resource configurations and access. - * Threat: - * Indicates a threat that has obtained minimal access to an environment but - * is not able to access data, execute code, or create resources. + * For vulnerabilities: A low-risk vulnerability hampers a security + * organization's ability to detect vulnerabilities or active threats in + * their deployment, or prevents the root cause investigation of security + * issues. An example is monitoring and logs being disabled for resource + * configurations and access. + * For threats: Indicates a threat that has obtained minimal access to an + * environment but is not able to access data, execute code, or create + * resources. * * Generated from protobuf enum LOW = 4; */ diff --git a/SecurityCenterManagement/src/V1/SimulatedFinding/State.php b/SecurityCenterManagement/src/V1/SimulatedFinding/State.php index 8928295de963..04a918430491 100644 --- a/SecurityCenterManagement/src/V1/SimulatedFinding/State.php +++ b/SecurityCenterManagement/src/V1/SimulatedFinding/State.php @@ -14,7 +14,7 @@ class State { /** - * Unspecified state. + * Default value. This value is unused. * * Generated from protobuf enum STATE_UNSPECIFIED = 0; */ @@ -26,8 +26,8 @@ class State */ const ACTIVE = 1; /** - * The finding has been fixed, triaged as a non-issue or otherwise addressed - * and is no longer active. + * The finding has been fixed, triaged as a non-issue, or otherwise + * addressed and is no longer active. * * Generated from protobuf enum INACTIVE = 2; */ diff --git a/SecurityCenterManagement/src/V1/UpdateEventThreatDetectionCustomModuleRequest.php b/SecurityCenterManagement/src/V1/UpdateEventThreatDetectionCustomModuleRequest.php index 85584147f21c..58d66e3094cd 100644 --- a/SecurityCenterManagement/src/V1/UpdateEventThreatDetectionCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/UpdateEventThreatDetectionCustomModuleRequest.php @@ -16,41 +16,36 @@ class UpdateEventThreatDetectionCustomModuleRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Field mask is used to specify the fields to be overwritten in the - * EventThreatDetectionCustomModule resource by the update. - * The fields specified in the update_mask are relative to the resource, not - * the full request. A field will be overwritten if it is in the mask. If the - * user does not provide a mask then all fields will be overwritten. + * Required. The fields to update. If omitted, then all fields are updated. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; */ protected $update_mask = null; /** - * Required. The module being updated + * Required. The module being updated. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_module = 2 [(.google.api.field_behavior) = REQUIRED]; */ protected $event_threat_detection_custom_module = null; /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be updated). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually update the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to update the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be updated. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $validate_only = false; /** - * @param \Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule $eventThreatDetectionCustomModule Required. The module being updated - * @param \Google\Protobuf\FieldMask $updateMask Required. Field mask is used to specify the fields to be overwritten in the - * EventThreatDetectionCustomModule resource by the update. - * The fields specified in the update_mask are relative to the resource, not - * the full request. A field will be overwritten if it is in the mask. If the - * user does not provide a mask then all fields will be overwritten. + * @param \Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule $eventThreatDetectionCustomModule Required. The module being updated. + * @param \Google\Protobuf\FieldMask $updateMask Required. The fields to update. If omitted, then all fields are updated. * * @return \Google\Cloud\SecurityCenterManagement\V1\UpdateEventThreatDetectionCustomModuleRequest * @@ -70,21 +65,20 @@ public static function build(\Google\Cloud\SecurityCenterManagement\V1\EventThre * Optional. Data for populating the Message object. * * @type \Google\Protobuf\FieldMask $update_mask - * Required. Field mask is used to specify the fields to be overwritten in the - * EventThreatDetectionCustomModule resource by the update. - * The fields specified in the update_mask are relative to the resource, not - * the full request. A field will be overwritten if it is in the mask. If the - * user does not provide a mask then all fields will be overwritten. + * Required. The fields to update. If omitted, then all fields are updated. * @type \Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule $event_threat_detection_custom_module - * Required. The module being updated + * Required. The module being updated. * @type bool $validate_only - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be updated). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually update the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to update the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be updated. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * } */ public function __construct($data = NULL) { @@ -93,11 +87,7 @@ public function __construct($data = NULL) { } /** - * Required. Field mask is used to specify the fields to be overwritten in the - * EventThreatDetectionCustomModule resource by the update. - * The fields specified in the update_mask are relative to the resource, not - * the full request. A field will be overwritten if it is in the mask. If the - * user does not provide a mask then all fields will be overwritten. + * Required. The fields to update. If omitted, then all fields are updated. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Protobuf\FieldMask|null @@ -118,11 +108,7 @@ public function clearUpdateMask() } /** - * Required. Field mask is used to specify the fields to be overwritten in the - * EventThreatDetectionCustomModule resource by the update. - * The fields specified in the update_mask are relative to the resource, not - * the full request. A field will be overwritten if it is in the mask. If the - * user does not provide a mask then all fields will be overwritten. + * Required. The fields to update. If omitted, then all fields are updated. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Protobuf\FieldMask $var @@ -137,7 +123,7 @@ public function setUpdateMask($var) } /** - * Required. The module being updated + * Required. The module being updated. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_module = 2 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule|null @@ -158,7 +144,7 @@ public function clearEventThreatDetectionCustomModule() } /** - * Required. The module being updated + * Required. The module being updated. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_module = 2 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule $var @@ -173,13 +159,16 @@ public function setEventThreatDetectionCustomModule($var) } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be updated). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually update the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to update the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be updated. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -190,13 +179,16 @@ public function getValidateOnly() } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be updated). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually update the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to update the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be updated. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/SecurityCenterManagement/src/V1/UpdateSecurityCenterServiceRequest.php b/SecurityCenterManagement/src/V1/UpdateSecurityCenterServiceRequest.php index 9f8693b99a17..5ba8a72d9a40 100644 --- a/SecurityCenterManagement/src/V1/UpdateSecurityCenterServiceRequest.php +++ b/SecurityCenterManagement/src/V1/UpdateSecurityCenterServiceRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message for updating a Security Command Center service. + * Request message for + * [SecurityCenterManagement.UpdateSecurityCenterService][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.UpdateSecurityCenterService]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.UpdateSecurityCenterServiceRequest */ @@ -22,21 +23,25 @@ class UpdateSecurityCenterServiceRequest extends \Google\Protobuf\Internal\Messa */ protected $security_center_service = null; /** - * Required. The list of fields to be updated. Possible values: - * * "intended_enablement_state" - * * "modules" + * Required. The fields to update. Accepts the following values: + * * `intended_enablement_state` + * * `modules` + * If omitted, then all eligible fields are updated. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; */ protected $update_mask = null; /** - * Optional. When set to true, only validations (including IAM checks) will be - * done for the request (service will not be updated). An OK response - * indicates that the request is valid, while an error response indicates that - * the request is invalid. Note that a subsequent request to actually update - * the service could still fail for one of the following reasons: - * - The state could have changed (e.g. IAM permission lost). - * - A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no service will be updated. An `OK` response indicates that + * the request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the service could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during update of the service + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -44,10 +49,12 @@ class UpdateSecurityCenterServiceRequest extends \Google\Protobuf\Internal\Messa /** * @param \Google\Cloud\SecurityCenterManagement\V1\SecurityCenterService $securityCenterService Required. The updated service. - * @param \Google\Protobuf\FieldMask $updateMask Required. The list of fields to be updated. Possible values: + * @param \Google\Protobuf\FieldMask $updateMask Required. The fields to update. Accepts the following values: * - * * "intended_enablement_state" - * * "modules" + * * `intended_enablement_state` + * * `modules` + * + * If omitted, then all eligible fields are updated. * * @return \Google\Cloud\SecurityCenterManagement\V1\UpdateSecurityCenterServiceRequest * @@ -69,17 +76,21 @@ public static function build(\Google\Cloud\SecurityCenterManagement\V1\SecurityC * @type \Google\Cloud\SecurityCenterManagement\V1\SecurityCenterService $security_center_service * Required. The updated service. * @type \Google\Protobuf\FieldMask $update_mask - * Required. The list of fields to be updated. Possible values: - * * "intended_enablement_state" - * * "modules" + * Required. The fields to update. Accepts the following values: + * * `intended_enablement_state` + * * `modules` + * If omitted, then all eligible fields are updated. * @type bool $validate_only - * Optional. When set to true, only validations (including IAM checks) will be - * done for the request (service will not be updated). An OK response - * indicates that the request is valid, while an error response indicates that - * the request is invalid. Note that a subsequent request to actually update - * the service could still fail for one of the following reasons: - * - The state could have changed (e.g. IAM permission lost). - * - A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no service will be updated. An `OK` response indicates that + * the request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the service could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during update of the service + * Defaults to `false`. * } */ public function __construct($data = NULL) { @@ -124,9 +135,10 @@ public function setSecurityCenterService($var) } /** - * Required. The list of fields to be updated. Possible values: - * * "intended_enablement_state" - * * "modules" + * Required. The fields to update. Accepts the following values: + * * `intended_enablement_state` + * * `modules` + * If omitted, then all eligible fields are updated. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Protobuf\FieldMask|null @@ -147,9 +159,10 @@ public function clearUpdateMask() } /** - * Required. The list of fields to be updated. Possible values: - * * "intended_enablement_state" - * * "modules" + * Required. The fields to update. Accepts the following values: + * * `intended_enablement_state` + * * `modules` + * If omitted, then all eligible fields are updated. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Protobuf\FieldMask $var @@ -164,13 +177,16 @@ public function setUpdateMask($var) } /** - * Optional. When set to true, only validations (including IAM checks) will be - * done for the request (service will not be updated). An OK response - * indicates that the request is valid, while an error response indicates that - * the request is invalid. Note that a subsequent request to actually update - * the service could still fail for one of the following reasons: - * - The state could have changed (e.g. IAM permission lost). - * - A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no service will be updated. An `OK` response indicates that + * the request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the service could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during update of the service + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -181,13 +197,16 @@ public function getValidateOnly() } /** - * Optional. When set to true, only validations (including IAM checks) will be - * done for the request (service will not be updated). An OK response - * indicates that the request is valid, while an error response indicates that - * the request is invalid. Note that a subsequent request to actually update - * the service could still fail for one of the following reasons: - * - The state could have changed (e.g. IAM permission lost). - * - A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no service will be updated. An `OK` response indicates that + * the request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the service could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during update of the service + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/SecurityCenterManagement/src/V1/UpdateSecurityHealthAnalyticsCustomModuleRequest.php b/SecurityCenterManagement/src/V1/UpdateSecurityHealthAnalyticsCustomModuleRequest.php index 9fb49e8da926..f78f9396668e 100644 --- a/SecurityCenterManagement/src/V1/UpdateSecurityHealthAnalyticsCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/UpdateSecurityHealthAnalyticsCustomModuleRequest.php @@ -9,46 +9,54 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Message for updating a SecurityHealthAnalyticsCustomModule + * Request message for + * [SecurityCenterManagement.UpdateSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.UpdateSecurityHealthAnalyticsCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.UpdateSecurityHealthAnalyticsCustomModuleRequest */ class UpdateSecurityHealthAnalyticsCustomModuleRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The list of fields to be updated. The only fields that can be - * updated are `enablement_state` and `custom_config`. If empty or set to the - * wildcard value `*`, both `enablement_state` and `custom_config` are - * updated. + * Required. The fields to update. The following values are valid: + * * `custom_config` + * * `enablement_state` + * If you omit this field or set it to the wildcard value `*`, then all + * eligible fields are updated. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; */ protected $update_mask = null; /** - * Required. The resource being updated + * Required. The resource being updated. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule security_health_analytics_custom_module = 2 [(.google.api.field_behavior) = REQUIRED]; */ protected $security_health_analytics_custom_module = null; /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be updated). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually update the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to update the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be updated. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $validate_only = false; /** - * @param \Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule $securityHealthAnalyticsCustomModule Required. The resource being updated - * @param \Google\Protobuf\FieldMask $updateMask Required. The list of fields to be updated. The only fields that can be - * updated are `enablement_state` and `custom_config`. If empty or set to the - * wildcard value `*`, both `enablement_state` and `custom_config` are - * updated. + * @param \Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule $securityHealthAnalyticsCustomModule Required. The resource being updated. + * @param \Google\Protobuf\FieldMask $updateMask Required. The fields to update. The following values are valid: + * + * * `custom_config` + * * `enablement_state` + * + * If you omit this field or set it to the wildcard value `*`, then all + * eligible fields are updated. * * @return \Google\Cloud\SecurityCenterManagement\V1\UpdateSecurityHealthAnalyticsCustomModuleRequest * @@ -68,20 +76,24 @@ public static function build(\Google\Cloud\SecurityCenterManagement\V1\SecurityH * Optional. Data for populating the Message object. * * @type \Google\Protobuf\FieldMask $update_mask - * Required. The list of fields to be updated. The only fields that can be - * updated are `enablement_state` and `custom_config`. If empty or set to the - * wildcard value `*`, both `enablement_state` and `custom_config` are - * updated. + * Required. The fields to update. The following values are valid: + * * `custom_config` + * * `enablement_state` + * If you omit this field or set it to the wildcard value `*`, then all + * eligible fields are updated. * @type \Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule $security_health_analytics_custom_module - * Required. The resource being updated + * Required. The resource being updated. * @type bool $validate_only - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be updated). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually update the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to update the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be updated. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * } */ public function __construct($data = NULL) { @@ -90,10 +102,11 @@ public function __construct($data = NULL) { } /** - * Required. The list of fields to be updated. The only fields that can be - * updated are `enablement_state` and `custom_config`. If empty or set to the - * wildcard value `*`, both `enablement_state` and `custom_config` are - * updated. + * Required. The fields to update. The following values are valid: + * * `custom_config` + * * `enablement_state` + * If you omit this field or set it to the wildcard value `*`, then all + * eligible fields are updated. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Protobuf\FieldMask|null @@ -114,10 +127,11 @@ public function clearUpdateMask() } /** - * Required. The list of fields to be updated. The only fields that can be - * updated are `enablement_state` and `custom_config`. If empty or set to the - * wildcard value `*`, both `enablement_state` and `custom_config` are - * updated. + * Required. The fields to update. The following values are valid: + * * `custom_config` + * * `enablement_state` + * If you omit this field or set it to the wildcard value `*`, then all + * eligible fields are updated. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Protobuf\FieldMask $var @@ -132,7 +146,7 @@ public function setUpdateMask($var) } /** - * Required. The resource being updated + * Required. The resource being updated. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule security_health_analytics_custom_module = 2 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule|null @@ -153,7 +167,7 @@ public function clearSecurityHealthAnalyticsCustomModule() } /** - * Required. The resource being updated + * Required. The resource being updated. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule security_health_analytics_custom_module = 2 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule $var @@ -168,13 +182,16 @@ public function setSecurityHealthAnalyticsCustomModule($var) } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be updated). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually update the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to update the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be updated. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -185,13 +202,16 @@ public function getValidateOnly() } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be updated). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually update the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to update the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be updated. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleRequest.php b/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleRequest.php index 40ac0673ade5..eec986d1de88 100644 --- a/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleRequest.php @@ -9,16 +9,17 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request to validate an Event Threat Detection custom module. + * Request message for + * [SecurityCenterManagement.ValidateEventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ValidateEventThreatDetectionCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ValidateEventThreatDetectionCustomModuleRequest */ class ValidateEventThreatDetectionCustomModuleRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Resource name of the parent to validate the Custom Module under. - * Its format is: - * * `organizations/{organization}/locations/{location}`. + * Required. Resource name of the parent to validate the custom modules under, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -31,7 +32,7 @@ class ValidateEventThreatDetectionCustomModuleRequest extends \Google\Protobuf\I */ protected $raw_text = ''; /** - * Required. The type of the module (e.g. CONFIGURABLE_BAD_IP). + * Required. The type of the module. For example, `CONFIGURABLE_BAD_IP`. * * Generated from protobuf field string type = 3 [(.google.api.field_behavior) = REQUIRED]; */ @@ -44,14 +45,14 @@ class ValidateEventThreatDetectionCustomModuleRequest extends \Google\Protobuf\I * Optional. Data for populating the Message object. * * @type string $parent - * Required. Resource name of the parent to validate the Custom Module under. - * Its format is: - * * `organizations/{organization}/locations/{location}`. + * Required. Resource name of the parent to validate the custom modules under, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}` * @type string $raw_text * Required. The raw text of the module's contents. Used to generate error * messages. * @type string $type - * Required. The type of the module (e.g. CONFIGURABLE_BAD_IP). + * Required. The type of the module. For example, `CONFIGURABLE_BAD_IP`. * } */ public function __construct($data = NULL) { @@ -60,9 +61,9 @@ public function __construct($data = NULL) { } /** - * Required. Resource name of the parent to validate the Custom Module under. - * Its format is: - * * `organizations/{organization}/locations/{location}`. + * Required. Resource name of the parent to validate the custom modules under, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -73,9 +74,9 @@ public function getParent() } /** - * Required. Resource name of the parent to validate the Custom Module under. - * Its format is: - * * `organizations/{organization}/locations/{location}`. + * Required. Resource name of the parent to validate the custom modules under, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -118,7 +119,7 @@ public function setRawText($var) } /** - * Required. The type of the module (e.g. CONFIGURABLE_BAD_IP). + * Required. The type of the module. For example, `CONFIGURABLE_BAD_IP`. * * Generated from protobuf field string type = 3 [(.google.api.field_behavior) = REQUIRED]; * @return string @@ -129,7 +130,7 @@ public function getType() } /** - * Required. The type of the module (e.g. CONFIGURABLE_BAD_IP). + * Required. The type of the module. For example, `CONFIGURABLE_BAD_IP`. * * Generated from protobuf field string type = 3 [(.google.api.field_behavior) = REQUIRED]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse.php b/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse.php index d5707cbe2e7c..5cb87b5f3fe9 100644 --- a/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse.php +++ b/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Response to validating an Event Threat Detection custom module. + * Response message for + * [SecurityCenterManagement.ValidateEventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ValidateEventThreatDetectionCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ValidateEventThreatDetectionCustomModuleResponse */ diff --git a/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse/CustomModuleValidationError.php b/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse/CustomModuleValidationError.php index 0a58f35ad461..6d7cb58e67e2 100644 --- a/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse/CustomModuleValidationError.php +++ b/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse/CustomModuleValidationError.php @@ -10,37 +10,38 @@ /** * An error encountered while validating the uploaded configuration of an - * Event Threat Detection Custom Module. + * Event Threat Detection custom module. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ValidateEventThreatDetectionCustomModuleResponse.CustomModuleValidationError */ class CustomModuleValidationError extends \Google\Protobuf\Internal\Message { /** - * A description of the error, suitable for human consumption. Required. + * A human-readable description of the error. * * Generated from protobuf field string description = 1; */ protected $description = ''; /** - * The path, in RFC 8901 JSON Pointer format, to the field that failed - * validation. This may be left empty if no specific field is affected. + * The path, in [RFC 6901: JSON + * Pointer](https://datatracker.ietf.org/doc/html/rfc6901) format, to the + * field that failed validation. Omitted if no specific field is affected. * * Generated from protobuf field string field_path = 2; */ protected $field_path = ''; /** * The initial position of the error in the uploaded text version of the - * module. This field may be omitted if no specific position applies, or if - * one could not be computed. + * module. Omitted if no specific position applies, or if the position could + * not be computed. * * Generated from protobuf field optional .google.cloud.securitycentermanagement.v1.ValidateEventThreatDetectionCustomModuleResponse.Position start = 3; */ protected $start = null; /** - * The end position of the error in the uploaded text version of the - * module. This field may be omitted if no specific position applies, or if - * one could not be computed.. + * The end position of the error in the uploaded text version of the module. + * Omitted if no specific position applies, or if the position could not be + * computed. * * Generated from protobuf field optional .google.cloud.securitycentermanagement.v1.ValidateEventThreatDetectionCustomModuleResponse.Position end = 4; */ @@ -53,18 +54,19 @@ class CustomModuleValidationError extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $description - * A description of the error, suitable for human consumption. Required. + * A human-readable description of the error. * @type string $field_path - * The path, in RFC 8901 JSON Pointer format, to the field that failed - * validation. This may be left empty if no specific field is affected. + * The path, in [RFC 6901: JSON + * Pointer](https://datatracker.ietf.org/doc/html/rfc6901) format, to the + * field that failed validation. Omitted if no specific field is affected. * @type \Google\Cloud\SecurityCenterManagement\V1\ValidateEventThreatDetectionCustomModuleResponse\Position $start * The initial position of the error in the uploaded text version of the - * module. This field may be omitted if no specific position applies, or if - * one could not be computed. + * module. Omitted if no specific position applies, or if the position could + * not be computed. * @type \Google\Cloud\SecurityCenterManagement\V1\ValidateEventThreatDetectionCustomModuleResponse\Position $end - * The end position of the error in the uploaded text version of the - * module. This field may be omitted if no specific position applies, or if - * one could not be computed.. + * The end position of the error in the uploaded text version of the module. + * Omitted if no specific position applies, or if the position could not be + * computed. * } */ public function __construct($data = NULL) { @@ -73,7 +75,7 @@ public function __construct($data = NULL) { } /** - * A description of the error, suitable for human consumption. Required. + * A human-readable description of the error. * * Generated from protobuf field string description = 1; * @return string @@ -84,7 +86,7 @@ public function getDescription() } /** - * A description of the error, suitable for human consumption. Required. + * A human-readable description of the error. * * Generated from protobuf field string description = 1; * @param string $var @@ -99,8 +101,9 @@ public function setDescription($var) } /** - * The path, in RFC 8901 JSON Pointer format, to the field that failed - * validation. This may be left empty if no specific field is affected. + * The path, in [RFC 6901: JSON + * Pointer](https://datatracker.ietf.org/doc/html/rfc6901) format, to the + * field that failed validation. Omitted if no specific field is affected. * * Generated from protobuf field string field_path = 2; * @return string @@ -111,8 +114,9 @@ public function getFieldPath() } /** - * The path, in RFC 8901 JSON Pointer format, to the field that failed - * validation. This may be left empty if no specific field is affected. + * The path, in [RFC 6901: JSON + * Pointer](https://datatracker.ietf.org/doc/html/rfc6901) format, to the + * field that failed validation. Omitted if no specific field is affected. * * Generated from protobuf field string field_path = 2; * @param string $var @@ -128,8 +132,8 @@ public function setFieldPath($var) /** * The initial position of the error in the uploaded text version of the - * module. This field may be omitted if no specific position applies, or if - * one could not be computed. + * module. Omitted if no specific position applies, or if the position could + * not be computed. * * Generated from protobuf field optional .google.cloud.securitycentermanagement.v1.ValidateEventThreatDetectionCustomModuleResponse.Position start = 3; * @return \Google\Cloud\SecurityCenterManagement\V1\ValidateEventThreatDetectionCustomModuleResponse\Position|null @@ -151,8 +155,8 @@ public function clearStart() /** * The initial position of the error in the uploaded text version of the - * module. This field may be omitted if no specific position applies, or if - * one could not be computed. + * module. Omitted if no specific position applies, or if the position could + * not be computed. * * Generated from protobuf field optional .google.cloud.securitycentermanagement.v1.ValidateEventThreatDetectionCustomModuleResponse.Position start = 3; * @param \Google\Cloud\SecurityCenterManagement\V1\ValidateEventThreatDetectionCustomModuleResponse\Position $var @@ -167,9 +171,9 @@ public function setStart($var) } /** - * The end position of the error in the uploaded text version of the - * module. This field may be omitted if no specific position applies, or if - * one could not be computed.. + * The end position of the error in the uploaded text version of the module. + * Omitted if no specific position applies, or if the position could not be + * computed. * * Generated from protobuf field optional .google.cloud.securitycentermanagement.v1.ValidateEventThreatDetectionCustomModuleResponse.Position end = 4; * @return \Google\Cloud\SecurityCenterManagement\V1\ValidateEventThreatDetectionCustomModuleResponse\Position|null @@ -190,9 +194,9 @@ public function clearEnd() } /** - * The end position of the error in the uploaded text version of the - * module. This field may be omitted if no specific position applies, or if - * one could not be computed.. + * The end position of the error in the uploaded text version of the module. + * Omitted if no specific position applies, or if the position could not be + * computed. * * Generated from protobuf field optional .google.cloud.securitycentermanagement.v1.ValidateEventThreatDetectionCustomModuleResponse.Position end = 4; * @param \Google\Cloud\SecurityCenterManagement\V1\ValidateEventThreatDetectionCustomModuleResponse\Position $var diff --git a/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse/Position.php b/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse/Position.php index c037f7c08192..6286241981b9 100644 --- a/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse/Position.php +++ b/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse/Position.php @@ -16,13 +16,13 @@ class Position extends \Google\Protobuf\Internal\Message { /** - * The line position in the text + * The line position in the text. * * Generated from protobuf field int32 line_number = 1; */ protected $line_number = 0; /** - * The column position in the line + * The column position in the line. * * Generated from protobuf field int32 column_number = 2; */ @@ -35,9 +35,9 @@ class Position extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type int $line_number - * The line position in the text + * The line position in the text. * @type int $column_number - * The column position in the line + * The column position in the line. * } */ public function __construct($data = NULL) { @@ -46,7 +46,7 @@ public function __construct($data = NULL) { } /** - * The line position in the text + * The line position in the text. * * Generated from protobuf field int32 line_number = 1; * @return int @@ -57,7 +57,7 @@ public function getLineNumber() } /** - * The line position in the text + * The line position in the text. * * Generated from protobuf field int32 line_number = 1; * @param int $var @@ -72,7 +72,7 @@ public function setLineNumber($var) } /** - * The column position in the line + * The column position in the line. * * Generated from protobuf field int32 column_number = 2; * @return int @@ -83,7 +83,7 @@ public function getColumnNumber() } /** - * The column position in the line + * The column position in the line. * * Generated from protobuf field int32 column_number = 2; * @param int $var