security_feedback

Creates, updates, deletes, gets or lists a security_feedback resource.

Overview

Name	security_feedback
Type	Resource
Id	google.apigee.security_feedback

Fields

The following fields are returned by SELECT queries:

organizations_security_feedback_get

Name	Datatype	Description
name	string	Output only. Identifier. The feedback name is intended to be a system-generated uuid.
comment	string	Optional. Optional text the user can provide for additional, unstructured context.
createTime	string (google-datetime)	Output only. The time when this specific feedback id was created.
displayName	string	Optional. The display name of the feedback.
feedbackContexts	array	Required. One or more attribute/value pairs for constraining the feedback.
feedbackType	string	Required. The type of feedback being submitted.
reason	string	Optional. The reason for the feedback.
updateTime	string (google-datetime)	Output only. The time when this specific feedback id was updated.

organizations_security_feedback_list

Name	Datatype	Description
name	string	Output only. Identifier. The feedback name is intended to be a system-generated uuid.
comment	string	Optional. Optional text the user can provide for additional, unstructured context.
createTime	string (google-datetime)	Output only. The time when this specific feedback id was created.
displayName	string	Optional. The display name of the feedback.
feedbackContexts	array	Required. One or more attribute/value pairs for constraining the feedback.
feedbackType	string	Required. The type of feedback being submitted.
reason	string	Optional. The reason for the feedback.
updateTime	string (google-datetime)	Output only. The time when this specific feedback id was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_security_feedback_get	select	organizationsId, securityFeedbackId		Gets a specific customer feedback report.
organizations_security_feedback_list	select	organizationsId	pageToken, pageSize	Lists all feedback reports which have already been submitted.
organizations_security_feedback_create	insert	organizationsId	securityFeedbackId	Creates a new report containing customer feedback.
organizations_security_feedback_patch	update	organizationsId, securityFeedbackId	updateMask	Updates a specific feedback report.
organizations_security_feedback_delete	delete	organizationsId, securityFeedbackId		Deletes a specific feedback report. Used for "undo" of a feedback submission.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
organizationsId	string
securityFeedbackId	string
pageSize	integer (int32)
pageToken	string
securityFeedbackId	string
updateMask	string (google-fieldmask)

SELECT examples

organizations_security_feedback_get

Gets a specific customer feedback report.

SELECT
name,
comment,
createTime,
displayName,
feedbackContexts,
feedbackType,
reason,
updateTime
FROM google.apigee.security_feedback
WHERE organizationsId = '{{ organizationsId }}' -- required
AND securityFeedbackId = '{{ securityFeedbackId }}' -- required
;

organizations_security_feedback_list

Lists all feedback reports which have already been submitted.

SELECT
name,
comment,
createTime,
displayName,
feedbackContexts,
feedbackType,
reason,
updateTime
FROM google.apigee.security_feedback
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

organizations_security_feedback_create

Creates a new report containing customer feedback.

INSERT INTO google.apigee.security_feedback (
data__feedbackContexts,
data__feedbackType,
data__reason,
data__displayName,
data__comment,
organizationsId,
securityFeedbackId
)
SELECT 
'{{ feedbackContexts }}',
'{{ feedbackType }}',
'{{ reason }}',
'{{ displayName }}',
'{{ comment }}',
'{{ organizationsId }}',
'{{ securityFeedbackId }}'
RETURNING
name,
comment,
createTime,
displayName,
feedbackContexts,
feedbackType,
reason,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: security_feedback
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the security_feedback resource.
    - name: feedbackContexts
      value: array
      description: >
        Required. One or more attribute/value pairs for constraining the feedback.
        
    - name: feedbackType
      value: string
      description: >
        Required. The type of feedback being submitted.
        
      valid_values: ['FEEDBACK_TYPE_UNSPECIFIED', 'EXCLUDED_DETECTION']
    - name: reason
      value: string
      description: >
        Optional. The reason for the feedback.
        
      valid_values: ['REASON_UNSPECIFIED', 'INTERNAL_SYSTEM', 'NON_RISK_CLIENT', 'NAT', 'PENETRATION_TEST', 'OTHER']
    - name: displayName
      value: string
      description: >
        Optional. The display name of the feedback.
        
    - name: comment
      value: string
      description: >
        Optional. Optional text the user can provide for additional, unstructured context.
        
    - name: securityFeedbackId
      value: string

UPDATE examples

organizations_security_feedback_patch

Updates a specific feedback report.

UPDATE google.apigee.security_feedback
SET 
data__feedbackContexts = '{{ feedbackContexts }}',
data__feedbackType = '{{ feedbackType }}',
data__reason = '{{ reason }}',
data__displayName = '{{ displayName }}',
data__comment = '{{ comment }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND securityFeedbackId = '{{ securityFeedbackId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
comment,
createTime,
displayName,
feedbackContexts,
feedbackType,
reason,
updateTime;

DELETE examples

organizations_security_feedback_delete

Deletes a specific feedback report. Used for "undo" of a feedback submission.

DELETE FROM google.apigee.security_feedback
WHERE organizationsId = '{{ organizationsId }}' --required
AND securityFeedbackId = '{{ securityFeedbackId }}' --required
;