feat(cloudsearch): update the API

#### cloudsearch:v1 The following keys were added: - schemas.AuditLoggingSettings.description - schemas.AuditLoggingSettings.id - schemas.AuditLoggingSettings.properties.logAdminReadActions.description - schemas.AuditLoggingSettings.properties.logAdminReadActions.type - schemas.AuditLoggingSettings.properties.logDataReadActions.description - schemas.AuditLoggingSettings.properties.logDataReadActions.type - schemas.AuditLoggingSettings.properties.logDataWriteActions.description - schemas.AuditLoggingSettings.properties.logDataWriteActions.type - schemas.AuditLoggingSettings.properties.project.description - schemas.AuditLoggingSettings.properties.project.type - schemas.AuditLoggingSettings.type - schemas.ContextAttribute.description - schemas.ContextAttribute.id - schemas.ContextAttribute.properties.name.description - schemas.ContextAttribute.properties.name.type - schemas.ContextAttribute.properties.values.description - schemas.ContextAttribute.properties.values.items.type - schemas.ContextAttribute.properties.values.type - schemas.ContextAttribute.type - schemas.CustomerSettings.properties.auditLoggingSettings.$ref - schemas.CustomerSettings.properties.auditLoggingSettings.description - schemas.ItemMetadata.properties.contextAttributes.description - schemas.ItemMetadata.properties.contextAttributes.items.$ref - schemas.ItemMetadata.properties.contextAttributes.type - schemas.SearchApplication.properties.enableAuditLog.description - schemas.SearchApplication.properties.enableAuditLog.type - schemas.SearchRequest.properties.contextAttributes.description - schemas.SearchRequest.properties.contextAttributes.items.$ref - schemas.SearchRequest.properties.contextAttributes.type
googleapis · Apr 20, 2021 · f7579e2 · f7579e2
1 parent f6845f2
commit f7579e2
Show file tree

Hide file tree

Showing 2 changed files with 120 additions and 1 deletion.
diff --git a/discovery/cloudsearch-v1.json b/discovery/cloudsearch-v1.json
@@ -1916,9 +1916,32 @@
       }
     }
   },
-  "revision": "20210322",
+  "revision": "20210406",
   "rootUrl": "https://cloudsearch.googleapis.com/",
   "schemas": {
+    "AuditLoggingSettings": {
+      "description": "Represents the settings for Cloud audit logging",
+      "id": "AuditLoggingSettings",
+      "properties": {
+        "logAdminReadActions": {
+          "description": "Indicates whether audit logging is on/off for admin activity read APIs i.e. Get/List DataSources, Get/List SearchApplications etc.",
+          "type": "boolean"
+        },
+        "logDataReadActions": {
+          "description": "Indicates whether audit logging is on/off for data access read APIs i.e. ListItems, GetItem etc.",
+          "type": "boolean"
+        },
+        "logDataWriteActions": {
+          "description": "Indicates whether audit logging is on/off for data access write APIs i.e. IndexItem etc.",
+          "type": "boolean"
+        },
+        "project": {
+          "description": "The resource name of the GCP Project to store audit logs. Cloud audit logging will be enabled after project_name has been updated through CustomerService. Format: projects/{project_id}",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "BooleanOperatorOptions": {
       "description": "Used to provide a search operator for boolean properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.",
       "id": "BooleanOperatorOptions",
@@ -1978,6 +2001,24 @@
       },
       "type": "object"
     },
+    "ContextAttribute": {
+      "description": "A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.",
+      "id": "ContextAttribute",
+      "properties": {
+        "name": {
+          "description": "The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched.",
+          "type": "string"
+        },
+        "values": {
+          "description": "Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
     "CustomerIndexStats": {
       "description": "Aggregation of items by status code as of the specified date.",
       "id": "CustomerIndexStats",
@@ -2031,6 +2072,10 @@
       "description": "Represents settings at a customer level.",
       "id": "CustomerSettings",
       "properties": {
+        "auditLoggingSettings": {
+          "$ref": "AuditLoggingSettings",
+          "description": "Audit Logging settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request."
+        },
         "vpcSettings": {
           "$ref": "VPCSettings",
           "description": "VPC SC settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request."
@@ -3119,6 +3164,13 @@
           "description": "The BCP-47 language code for the item, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.",
           "type": "string"
         },
+        "contextAttributes": {
+          "description": "A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10.",
+          "items": {
+            "$ref": "ContextAttribute"
+          },
+          "type": "array"
+        },
         "createTime": {
           "description": "The time when the item was created in the source repository.",
           "format": "google-datetime",
@@ -4367,6 +4419,10 @@
           "description": "Display name of the Search Application. The maximum length is 300 characters.",
           "type": "string"
         },
+        "enableAuditLog": {
+          "description": "Indicates whether audit logging is on/off for requests made for the search application in query APIs.",
+          "type": "boolean"
+        },
         "name": {
           "description": "Name of the Search Application. Format: searchapplications/{application_id}.",
           "type": "string"
@@ -4499,6 +4555,13 @@
       "description": "The search API request.",
       "id": "SearchRequest",
       "properties": {
+        "contextAttributes": {
+          "description": "Context attributes for the request which will be used to adjust ranking of search results. The maximum number of elements is 10.",
+          "items": {
+            "$ref": "ContextAttribute"
+          },
+          "type": "array"
+        },
         "dataSourceRestrictions": {
           "description": "The sources to use for querying. If not specified, all data sources from the current search application are used.",
           "items": {

diff --git a/src/apis/cloudsearch/v1.ts b/src/apis/cloudsearch/v1.ts
@@ -137,6 +137,27 @@ export namespace cloudsearch_v1 {
     }
   }
 
+  /**
+   * Represents the settings for Cloud audit logging
+   */
+  export interface Schema$AuditLoggingSettings {
+    /**
+     * Indicates whether audit logging is on/off for admin activity read APIs i.e. Get/List DataSources, Get/List SearchApplications etc.
+     */
+    logAdminReadActions?: boolean | null;
+    /**
+     * Indicates whether audit logging is on/off for data access read APIs i.e. ListItems, GetItem etc.
+     */
+    logDataReadActions?: boolean | null;
+    /**
+     * Indicates whether audit logging is on/off for data access write APIs i.e. IndexItem etc.
+     */
+    logDataWriteActions?: boolean | null;
+    /**
+     * The resource name of the GCP Project to store audit logs. Cloud audit logging will be enabled after project_name has been updated through CustomerService. Format: projects/{project_id\}
+     */
+    project?: string | null;
+  }
   /**
    * Used to provide a search operator for boolean properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
    */
@@ -171,6 +192,19 @@ export namespace cloudsearch_v1 {
      */
     subFilters?: Schema$Filter[];
   }
+  /**
+   * A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.
+   */
+  export interface Schema$ContextAttribute {
+    /**
+     * The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched.
+     */
+    name?: string | null;
+    /**
+     * Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched.
+     */
+    values?: string[] | null;
+  }
   /**
    * Aggregation of items by status code as of the specified date.
    */
@@ -205,6 +239,10 @@ export namespace cloudsearch_v1 {
    * Represents settings at a customer level.
    */
   export interface Schema$CustomerSettings {
+    /**
+     * Audit Logging settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request.
+     */
+    auditLoggingSettings?: Schema$AuditLoggingSettings;
     /**
      * VPC SC settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request.
      */
@@ -857,6 +895,10 @@ export namespace cloudsearch_v1 {
      * The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
      */
     contentLanguage?: string | null;
+    /**
+     * A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10.
+     */
+    contextAttributes?: Schema$ContextAttribute[];
     /**
      * The time when the item was created in the source repository.
      */
@@ -1658,6 +1700,10 @@ export namespace cloudsearch_v1 {
      * Display name of the Search Application. The maximum length is 300 characters.
      */
     displayName?: string | null;
+    /**
+     * Indicates whether audit logging is on/off for requests made for the search application in query APIs.
+     */
+    enableAuditLog?: boolean | null;
     /**
      * Name of the Search Application. Format: searchapplications/{application_id\}.
      */
@@ -1744,6 +1790,10 @@ export namespace cloudsearch_v1 {
    * The search API request.
    */
   export interface Schema$SearchRequest {
+    /**
+     * Context attributes for the request which will be used to adjust ranking of search results. The maximum number of elements is 10.
+     */
+    contextAttributes?: Schema$ContextAttribute[];
     /**
      * The sources to use for querying. If not specified, all data sources from the current search application are used.
      */
@@ -5596,6 +5646,7 @@ export namespace cloudsearch_v1 {
      *     requestBody: {
      *       // request body parameters
      *       // {
+     *       //   "contextAttributes": [],
      *       //   "dataSourceRestrictions": [],
      *       //   "facetOptions": [],
      *       //   "pageSize": 0,
@@ -6082,6 +6133,7 @@ export namespace cloudsearch_v1 {
      *
      *   // Example response
      *   // {
+     *   //   "auditLoggingSettings": {},
      *   //   "vpcSettings": {}
      *   // }
      * }
@@ -6215,6 +6267,7 @@ export namespace cloudsearch_v1 {
      *     requestBody: {
      *       // request body parameters
      *       // {
+     *       //   "auditLoggingSettings": {},
      *       //   "vpcSettings": {}
      *       // }
      *     },
@@ -7166,6 +7219,7 @@ export namespace cloudsearch_v1 {
      *       //   "defaultFacetOptions": [],
      *       //   "defaultSortOptions": {},
      *       //   "displayName": "my_displayName",
+     *       //   "enableAuditLog": false,
      *       //   "name": "my_name",
      *       //   "operationIds": [],
      *       //   "scoringConfig": {},
@@ -7459,6 +7513,7 @@ export namespace cloudsearch_v1 {
      *   //   "defaultFacetOptions": [],
      *   //   "defaultSortOptions": {},
      *   //   "displayName": "my_displayName",
+     *   //   "enableAuditLog": false,
      *   //   "name": "my_name",
      *   //   "operationIds": [],
      *   //   "scoringConfig": {},
@@ -7894,6 +7949,7 @@ export namespace cloudsearch_v1 {
      *       //   "defaultFacetOptions": [],
      *       //   "defaultSortOptions": {},
      *       //   "displayName": "my_displayName",
+     *       //   "enableAuditLog": false,
      *       //   "name": "my_name",
      *       //   "operationIds": [],
      *       //   "scoringConfig": {},