feat(cloudsearch): update the api

yoshi-automation · yoshi-automation · commit 8f4100e6398a · 2022-02-18T22:44:45.000Z
#### cloudsearch:v1

The following keys were added:
- schemas.AppId (Total Keys: 6)
- schemas.AvatarInfo (Total Keys: 3)
- schemas.CustomEmoji (Total Keys: 13)
- schemas.CustomerId (Total Keys: 3)
- schemas.DmId (Total Keys: 3)
- schemas.Emoji (Total Keys: 4)
- schemas.GroupId (Total Keys: 4)
- schemas.SpaceId (Total Keys: 3)
- schemas.SpaceInfo (Total Keys: 8)
- schemas.UserId (Total Keys: 5)
diff --git a/docs/dyn/cloudsearch_v1.query.html b/docs/dyn/cloudsearch_v1.query.html
@@ -156,7 +156,7 @@ <h3>Method Details</h3>
     },
   ],
   &quot;pageSize&quot;: 42, # Maximum number of search results to return in one page. Valid values are between 1 and 100, inclusive. Default value is 10. Minimum value is 50 when results beyond 2000 are requested.
-  &quot;query&quot;: &quot;A String&quot;, # The raw query string. See supported search operators in the [Cloud search Cheat Sheet](https://support.google.com/a/users/answer/9299929)
+  &quot;query&quot;: &quot;A String&quot;, # The raw query string. See supported search operators in the [Narrow your search with operators](https://support.google.com/cloudsearch/answer/6172299)
   &quot;queryInterpretationOptions&quot;: { # Options to interpret user query. # Options to interpret the user query.
     &quot;disableNlInterpretation&quot;: True or False, # Flag to disable natural language (NL) interpretation of queries. Default is false, Set to true to disable natural language interpretation. NL interpretation only applies to predefined datasources.
     &quot;disableSupplementalResults&quot;: True or False, # Use this flag to disable supplemental results for a query. Supplemental results setting chosen at SearchApplication level will take precedence if set to True.
diff --git a/googleapiclient/discovery_cache/documents/cloudsearch.v1.json b/googleapiclient/discovery_cache/documents/cloudsearch.v1.json
@@ -1994,7 +1994,7 @@
       }
     }
   },
-  "revision": "20220201",
+  "revision": "20220207",
   "rootUrl": "https://cloudsearch.googleapis.com/",
   "schemas": {
     "AclInfo": {
@@ -2034,6 +2034,64 @@
       },
       "type": "object"
     },
+    "AppId": {
+      "description": "Identifier of an App.",
+      "id": "AppId",
+      "properties": {
+        "appType": {
+          "description": "Enum indicating the type of App this is.",
+          "enum": [
+            "APP_TYPE_UNSPECIFIED",
+            "APP",
+            "GSUITE_APP",
+            "INCOMING_WEBHOOK"
+          ],
+          "enumDescriptions": [
+            "",
+            "3P APP eg. external Bots(Asana Bot), 1P Bots(Drive Bot).",
+            "1P APP eg. Tasks, Meet, Docs, Calendar..",
+            "Asynchronous messages via an incoming webhook."
+          ],
+          "type": "string"
+        },
+        "gsuiteAppType": {
+          "description": "Enum indicating which 1P App this is when app_type is GSUITE_APP. Determined & set by the 1P API as a convenience for all users of this identifier(Eg. clients, chime, backend etc.) to map to 1P properties.",
+          "enum": [
+            "GSUITE_APP_TYPE_UNSPECIFIED",
+            "TASKS_APP",
+            "CALENDAR_APP",
+            "DOCS_APP",
+            "SHEETS_APP",
+            "SLIDES_APP",
+            "MEET_APP",
+            "FILE_SUGGESTION_APP",
+            "CONTACTS_APP",
+            "ACTIVITY_FEED_APP",
+            "DRIVE_APP"
+          ],
+          "enumDescriptions": [
+            "",
+            "",
+            "",
+            "",
+            "",
+            "",
+            "",
+            "Powered by Bullseye",
+            "",
+            "",
+            ""
+          ],
+          "type": "string"
+        },
+        "id": {
+          "description": "Numeric identifier of the App. Set to Project number for 1/3P Apps. For Webhook, this is WebhookId. Determined & set by the 1P API from App credentials on the side channel.",
+          "format": "int64",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "AuditLoggingSettings": {
       "description": "Represents the settings for Cloud audit logging",
       "id": "AuditLoggingSettings",
@@ -2057,6 +2115,15 @@
       },
       "type": "object"
     },
+    "AvatarInfo": {
+      "id": "AvatarInfo",
+      "properties": {
+        "emoji": {
+          "$ref": "Emoji"
+        }
+      },
+      "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",
@@ -2134,6 +2201,74 @@
       },
       "type": "object"
     },
+    "CustomEmoji": {
+      "description": "Proto representation of a custom emoji. May be used in both APIs and in Spanner, but certain fields should be restricted to one or the other. See the per-field documentation for details. NEXT_TAG: 11",
+      "id": "CustomEmoji",
+      "properties": {
+        "blobId": {
+          "description": "ID for the underlying image data in Blobstore. This field should *only* be present in Spanner or within the server, but should not be exposed in public APIs.",
+          "type": "string"
+        },
+        "createTimeMicros": {
+          "description": "Time when the Emoji was created, in microseconds. This field may be present in Spanner, within the server, or in public APIs.",
+          "format": "int64",
+          "type": "string"
+        },
+        "creatorUserId": {
+          "$ref": "UserId",
+          "description": "This field should *never* be persisted to Spanner."
+        },
+        "ownerCustomerId": {
+          "$ref": "CustomerId",
+          "description": "This field should *never* be persisted to Spanner."
+        },
+        "readToken": {
+          "description": "Opaque token that clients use to construct the URL for accessing the custom emoji\u2019s image data. This field is intended for API consumption, and should *never* be persisted to Spanner.",
+          "type": "string"
+        },
+        "shortcode": {
+          "description": "User-provided, human-readable ID for the custom emoji. Users are expected to observe this field in the UI instead of the UUID. This shortcode should be unique within an organization, but has no global uniqueness guarantees, unlike the UUID. This field should *never* be persisted to Spanner.",
+          "type": "string"
+        },
+        "state": {
+          "description": "Snapshot of the current state of the emoji, which may differ from the source-of-truth in the CustomEmojis table. This field should *never* be persisted to Spanner.",
+          "enum": [
+            "EMOJI_STATE_UNSPECIFIED",
+            "EMOJI_ENABLED",
+            "EMOJI_SYSTEM_DISABLED",
+            "EMOJI_HIDDEN",
+            "EMOJI_DELETED"
+          ],
+          "enumDescriptions": [
+            "",
+            "Emoji is visible and available to be used, subject to access control requirements.",
+            "Emoji can no longer be used (e.g. due to a shortcode conflict), but is not removed from existing embeddings.",
+            "Emoji is hidden from pickers, so new usages are not allowed, but is not removed from existing embeddings.",
+            "Emoji is removed everywhere and is not available to end-users."
+          ],
+          "type": "string"
+        },
+        "updateTimeMicros": {
+          "format": "int64",
+          "type": "string"
+        },
+        "uuid": {
+          "description": "Unique key for a custom emoji resource. Required. This field is *always* populated.",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "CustomerId": {
+      "description": "Represents a GSuite customer ID. Obfuscated with CustomerIdObfuscator.",
+      "id": "CustomerId",
+      "properties": {
+        "customerId": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "CustomerIndexStats": {
       "description": "Aggregation of items by status code as of the specified date.",
       "id": "CustomerIndexStats",
@@ -2432,6 +2567,16 @@
       },
       "type": "object"
     },
+    "DmId": {
+      "id": "DmId",
+      "properties": {
+        "dmId": {
+          "description": "Unique server assigned Id, per Direct Message Space.",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "DoubleOperatorOptions": {
       "description": "Used to provide a search operator for double properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.",
       "id": "DoubleOperatorOptions",
@@ -2589,6 +2734,20 @@
       },
       "type": "object"
     },
+    "Emoji": {
+      "id": "Emoji",
+      "properties": {
+        "customEmoji": {
+          "$ref": "CustomEmoji",
+          "description": "A custom emoji."
+        },
+        "unicode": {
+          "description": "A basic emoji represented by a unicode string.",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "EnumOperatorOptions": {
       "description": "Used to provide a search operator for enum properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. For example, if you provide no operator for a *priority* enum property with possible values *p0* and *p1*, a query that contains the term *p0* returns items that have *p0* as the value of the *priority* property, as well as any items that contain the string *p0* in other fields. If you provide an operator name for the enum, such as *priority*, then search users can use that operator to refine results to only items that have *p0* as this property's value, with the query *priority:p0*.",
       "id": "EnumOperatorOptions",
@@ -3075,6 +3234,21 @@
       },
       "type": "object"
     },
+    "GroupId": {
+      "description": "Id representing a group that could be a space, a chat, or a direct message space. Which ID is set here will determine which group",
+      "id": "GroupId",
+      "properties": {
+        "dmId": {
+          "$ref": "DmId",
+          "description": "Unique, immutable ID of the Direct Message Space"
+        },
+        "spaceId": {
+          "$ref": "SpaceId",
+          "description": "Unique, immutable ID of the Space"
+        }
+      },
+      "type": "object"
+    },
     "HtmlOperatorOptions": {
       "description": "Used to provide a search operator for html properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.",
       "id": "HtmlOperatorOptions",
@@ -4923,7 +5097,7 @@
           "type": "integer"
         },
         "query": {
-          "description": "The raw query string. See supported search operators in the [Cloud search Cheat Sheet](https://support.google.com/a/users/answer/9299929)",
+          "description": "The raw query string. See supported search operators in the [Narrow your search with operators](https://support.google.com/cloudsearch/answer/6172299)",
           "type": "string"
         },
         "queryInterpretationOptions": {
@@ -5234,6 +5408,58 @@
       },
       "type": "object"
     },
+    "SpaceId": {
+      "description": "Primary key for Space resource.",
+      "id": "SpaceId",
+      "properties": {
+        "spaceId": {
+          "description": "Unique, immutable ID of the Space",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "SpaceInfo": {
+      "description": "Defines the representation of a single matching space.",
+      "id": "SpaceInfo",
+      "properties": {
+        "avatarInfo": {
+          "$ref": "AvatarInfo"
+        },
+        "description": {
+          "type": "string"
+        },
+        "groupId": {
+          "$ref": "GroupId"
+        },
+        "name": {
+          "type": "string"
+        },
+        "numMembers": {
+          "format": "int32",
+          "type": "integer"
+        },
+        "userMembershipState": {
+          "description": "searching user's membership state in this space",
+          "enum": [
+            "MEMBER_UNKNOWN",
+            "MEMBER_INVITED",
+            "MEMBER_JOINED",
+            "MEMBER_NOT_A_MEMBER",
+            "MEMBER_FAILED"
+          ],
+          "enumDescriptions": [
+            "Default state, do not use",
+            "An invitation to the space has been sent",
+            "User has joined the space",
+            "User is not a member",
+            "This state should never be stored in Spanner. It is a state for responses to the clients to indicate that membership mutations have failed and the member is in its previous state."
+          ],
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "SpellResult": {
       "id": "SpellResult",
       "properties": {
@@ -5559,6 +5785,33 @@
       },
       "type": "object"
     },
+    "UserId": {
+      "description": "Primary key for User resource.",
+      "id": "UserId",
+      "properties": {
+        "id": {
+          "description": "Opaque, server-assigned ID of the User.",
+          "type": "string"
+        },
+        "originAppId": {
+          "$ref": "AppId",
+          "description": "Optional. Identifier of the App involved (directly or on behalf of a human creator) in creating this message. This is not set if the user posted a message directly, but is used in the case of, for example, a message being generated by a 1P integration based on a user action (creating an event, creating a task etc). This should only be used on the BE. For clients, please use the field in the FE message proto instead (google3/apps/dynamite/v1/frontend/api/message.proto?q=origin_app_id)."
+        },
+        "type": {
+          "description": "Clients do not need to send UserType to Backend, but Backend will always send this field to clients per the following rule: 1. For HUMAN Ids, the field is empty but by default .getType() will return HUMAN. 2. For BOT Ids, the field is ALWAYS set to BOT.",
+          "enum": [
+            "HUMAN",
+            "BOT"
+          ],
+          "enumDescriptions": [
+            "Notes on HUMAN type: 1) Leaving UserId.UserType field empty will return HUMAN as default value. This is expected because all the existing UserIds are without explicitly setting UserType, most of which are HUMAN Ids. For Bot Ids we will always set BOT in UserType field. 2) DO NOT explicitly set HUMAN as type. This is a proto2 issue, that a UserId with explicitly set default value HUMAN as type is NOT equal to an id without setting the field. aka. UserId id1 = UserId.newBuilder() .setId(\"dummy\").setType(UserType.HUMAN).build(); UserId id2 = UserId.newBuilder().setId(\"dummy\").build(); AssertThat(id1).isNotEqual(id2); AssertThat(id2.getType()).isEqualTo(UserType.HUMAN);",
+            ""
+          ],
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "VPCSettings": {
       "id": "VPCSettings",
       "properties": {
