Vertex AI Search for Retail API . projects

close()

Close httplib2 connections.

getAlertConfig(name, x__xgafv=None)

Get the AlertConfig of the requested project.

Args:
  name: string, Required. Full AlertConfig resource name. Format: projects/{project_number}/alertConfig (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Project level alert config.
  "alertPolicies": [ # Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]
    { # Alert policy for a customer.
      "alertGroup": "A String", # The feature that provides alerting capability. Supported value: - `search-data-quality` for retail search customers. - `conv-data-quality` for retail conversation customers.
      "enrollStatus": "A String", # The enrollment status of a customer.
      "recipients": [ # Recipients for the alert policy. One alert policy should not exceed 20 recipients.
        { # Recipient contact information.
          "emailAddress": "A String", # Email address of the recipient.
        },
      ],
    },
  ],
  "name": "A String", # Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig
}

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

Update the alert config of the requested project.

Args:
  name: string, Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig (required)
  body: object, The request body.
    The object takes the form of:

{ # Project level alert config.
  "alertPolicies": [ # Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]
    { # Alert policy for a customer.
      "alertGroup": "A String", # The feature that provides alerting capability. Supported value: - `search-data-quality` for retail search customers. - `conv-data-quality` for retail conversation customers.
      "enrollStatus": "A String", # The enrollment status of a customer.
      "recipients": [ # Recipients for the alert policy. One alert policy should not exceed 20 recipients.
        { # Recipient contact information.
          "emailAddress": "A String", # Email address of the recipient.
        },
      ],
    },
  ],
  "name": "A String", # Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig
}

  updateMask: string, Indicates which fields in the provided AlertConfig to update. If not set, all supported fields are updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Project level alert config.
  "alertPolicies": [ # Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]
    { # Alert policy for a customer.
      "alertGroup": "A String", # The feature that provides alerting capability. Supported value: - `search-data-quality` for retail search customers. - `conv-data-quality` for retail conversation customers.
      "enrollStatus": "A String", # The enrollment status of a customer.
      "recipients": [ # Recipients for the alert policy. One alert policy should not exceed 20 recipients.
        { # Recipient contact information.
          "emailAddress": "A String", # Email address of the recipient.
        },
      ],
    },
  ],
  "name": "A String", # Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig
}