Apigee API . organizations . securityFeedback

close()

Close httplib2 connections.

create(parent, body=None, securityFeedbackId=None, x__xgafv=None)

Creates a new report containing customer feedback.

Args:
  parent: string, Required. Name of the organization. Use the following structure in your request: `organizations/{org}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a feedback report from an Advanced API Security customer.
  "comment": "A String", # Optional. Optional text the user can provide for additional, unstructured context.
  "createTime": "A String", # Output only. The time when this specific feedback id was created.
  "displayName": "A String", # Optional. The display name of the feedback.
  "feedbackContexts": [ # Required. One or more attribute/value pairs for constraining the feedback.
    { # FeedbackContext captures the intent of the submitted feedback.
      "attribute": "A String", # Required. The attribute the user is providing feedback about.
      "values": [ # Required. The values of the attribute the user is providing feedback about.
        "A String",
      ],
    },
  ],
  "feedbackType": "A String", # Required. The type of feedback being submitted.
  "name": "A String", # Output only. Identifier. The feedback name is intended to be a system-generated uuid.
  "reason": "A String", # Optional. The reason for the feedback.
  "updateTime": "A String", # Output only. The time when this specific feedback id was updated.
}

  securityFeedbackId: string, Optional. The id for this feedback report. If not provided, it will be set to a system-generated UUID.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a feedback report from an Advanced API Security customer.
  "comment": "A String", # Optional. Optional text the user can provide for additional, unstructured context.
  "createTime": "A String", # Output only. The time when this specific feedback id was created.
  "displayName": "A String", # Optional. The display name of the feedback.
  "feedbackContexts": [ # Required. One or more attribute/value pairs for constraining the feedback.
    { # FeedbackContext captures the intent of the submitted feedback.
      "attribute": "A String", # Required. The attribute the user is providing feedback about.
      "values": [ # Required. The values of the attribute the user is providing feedback about.
        "A String",
      ],
    },
  ],
  "feedbackType": "A String", # Required. The type of feedback being submitted.
  "name": "A String", # Output only. Identifier. The feedback name is intended to be a system-generated uuid.
  "reason": "A String", # Optional. The reason for the feedback.
  "updateTime": "A String", # Output only. The time when this specific feedback id was updated.
}

delete(name, x__xgafv=None)

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

Args:
  name: string, Required. Name of the SecurityFeedback to delete. Use the following structure in your request: `organizations/{org}/securityFeedback/{feedback_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Gets a specific customer feedback report.

Args:
  name: string, Required. Name of the SecurityFeedback. Format: `organizations/{org}/securityFeedback/{feedback_id}` Example: organizations/apigee-organization-name/securityFeedback/feedback-id (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a feedback report from an Advanced API Security customer.
  "comment": "A String", # Optional. Optional text the user can provide for additional, unstructured context.
  "createTime": "A String", # Output only. The time when this specific feedback id was created.
  "displayName": "A String", # Optional. The display name of the feedback.
  "feedbackContexts": [ # Required. One or more attribute/value pairs for constraining the feedback.
    { # FeedbackContext captures the intent of the submitted feedback.
      "attribute": "A String", # Required. The attribute the user is providing feedback about.
      "values": [ # Required. The values of the attribute the user is providing feedback about.
        "A String",
      ],
    },
  ],
  "feedbackType": "A String", # Required. The type of feedback being submitted.
  "name": "A String", # Output only. Identifier. The feedback name is intended to be a system-generated uuid.
  "reason": "A String", # Optional. The reason for the feedback.
  "updateTime": "A String", # Output only. The time when this specific feedback id was updated.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists all feedback reports which have already been submitted.

Args:
  parent: string, Required. Name of the organization. Format: `organizations/{org}`. Example: organizations/apigee-organization-name/securityFeedback (required)
  pageSize: integer, Optional. The maximum number of feedback reports to return. The service may return fewer than this value. LINT.IfChange(documented_page_size_limits) If unspecified, at most 10 feedback reports will be returned. The maximum value is 100; values above 100 will be coerced to 100. LINT.ThenChange( //depot/google3/edge/sense/boq/service/v1/securityfeedback/securityfeedback_rpc.go:page_size_limits )
  pageToken: string, Optional. A page token, received from a previous `ListSecurityFeedback` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSecurityFeedback` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListSecurityFeedback
  "nextPageToken": "A String", # A token that can be sent as `page_token` in `ListSecurityFeedbackRequest` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "securityFeedback": [ # List of SecurityFeedback reports.
    { # Represents a feedback report from an Advanced API Security customer.
      "comment": "A String", # Optional. Optional text the user can provide for additional, unstructured context.
      "createTime": "A String", # Output only. The time when this specific feedback id was created.
      "displayName": "A String", # Optional. The display name of the feedback.
      "feedbackContexts": [ # Required. One or more attribute/value pairs for constraining the feedback.
        { # FeedbackContext captures the intent of the submitted feedback.
          "attribute": "A String", # Required. The attribute the user is providing feedback about.
          "values": [ # Required. The values of the attribute the user is providing feedback about.
            "A String",
          ],
        },
      ],
      "feedbackType": "A String", # Required. The type of feedback being submitted.
      "name": "A String", # Output only. Identifier. The feedback name is intended to be a system-generated uuid.
      "reason": "A String", # Optional. The reason for the feedback.
      "updateTime": "A String", # Output only. The time when this specific feedback id was updated.
    },
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates a specific feedback report.

Args:
  name: string, Output only. Identifier. The feedback name is intended to be a system-generated uuid. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a feedback report from an Advanced API Security customer.
  "comment": "A String", # Optional. Optional text the user can provide for additional, unstructured context.
  "createTime": "A String", # Output only. The time when this specific feedback id was created.
  "displayName": "A String", # Optional. The display name of the feedback.
  "feedbackContexts": [ # Required. One or more attribute/value pairs for constraining the feedback.
    { # FeedbackContext captures the intent of the submitted feedback.
      "attribute": "A String", # Required. The attribute the user is providing feedback about.
      "values": [ # Required. The values of the attribute the user is providing feedback about.
        "A String",
      ],
    },
  ],
  "feedbackType": "A String", # Required. The type of feedback being submitted.
  "name": "A String", # Output only. Identifier. The feedback name is intended to be a system-generated uuid.
  "reason": "A String", # Optional. The reason for the feedback.
  "updateTime": "A String", # Output only. The time when this specific feedback id was updated.
}

  updateMask: string, Optional. The list of fields to update.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a feedback report from an Advanced API Security customer.
  "comment": "A String", # Optional. Optional text the user can provide for additional, unstructured context.
  "createTime": "A String", # Output only. The time when this specific feedback id was created.
  "displayName": "A String", # Optional. The display name of the feedback.
  "feedbackContexts": [ # Required. One or more attribute/value pairs for constraining the feedback.
    { # FeedbackContext captures the intent of the submitted feedback.
      "attribute": "A String", # Required. The attribute the user is providing feedback about.
      "values": [ # Required. The values of the attribute the user is providing feedback about.
        "A String",
      ],
    },
  ],
  "feedbackType": "A String", # Required. The type of feedback being submitted.
  "name": "A String", # Output only. Identifier. The feedback name is intended to be a system-generated uuid.
  "reason": "A String", # Optional. The reason for the feedback.
  "updateTime": "A String", # Output only. The time when this specific feedback id was updated.
}