Skip to content

Commit

Permalink
feat: Add GroundedGenerationService API (#7779)
Browse files Browse the repository at this point in the history
feat: Add AdvancedCompleteQuery API
feat: Add lite search API to allow public website search with API key
feat: Add Sitemap APIs to preview channel
feat: Support search personalization to preview channel
feat: Support natural language understanding search
feat: Add BillingEstimation in data store
feat: Support Google Workspace search
feat: Support advanced boost search
feat: Add one_box_page_size on search
feat: support query regex in control match rules
docs: deprecate extractive_answers in answer generation
docs: deprecate asynchronous mode in answer generation
docs: keep the API doc up-to-date with recent changes
PiperOrigin-RevId: 691212731
Source-Link: googleapis/googleapis@e6b6ff9
Source-Link: googleapis/googleapis-gen@67144fd
Copy-Tag: eyJwIjoiU2VjdXJpdHlDZW50ZXJNYW5hZ2VtZW50Ly5Pd2xCb3QueWFtbCIsImgiOiI2NzE0NGZkNDNjNWEzZTE2NDQxMGIzNjE3ZTU3NTJmMmUwNjZlYzI1In0=
  • Loading branch information
gcf-owl-bot[bot] authored Oct 31, 2024
1 parent ab36815 commit cb053e3
Show file tree
Hide file tree
Showing 72 changed files with 1,719 additions and 1,517 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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}`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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}`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
Loading

0 comments on commit cb053e3

Please sign in to comment.