@googleapis/discoveryengine 24.0.0 → 25.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +18 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +2919 -375
- package/build/v1.js +331 -0
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +3556 -215
- package/build/v1alpha.js +638 -3
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +2020 -45
- package/build/v1beta.js +169 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +3680 -298
- package/v1alpha.ts +5371 -409
- package/v1beta.ts +2659 -270
package/build/v1.d.ts
CHANGED
|
@@ -732,6 +732,46 @@ export declare namespace discoveryengine_v1 {
|
|
|
732
732
|
*/
|
|
733
733
|
functionName?: string | null;
|
|
734
734
|
}
|
|
735
|
+
/**
|
|
736
|
+
* Access Control Configuration.
|
|
737
|
+
*/
|
|
738
|
+
export interface Schema$GoogleCloudDiscoveryengineV1AclConfig {
|
|
739
|
+
/**
|
|
740
|
+
* Identity provider config.
|
|
741
|
+
*/
|
|
742
|
+
idpConfig?: Schema$GoogleCloudDiscoveryengineV1IdpConfig;
|
|
743
|
+
/**
|
|
744
|
+
* Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
745
|
+
*/
|
|
746
|
+
name?: string | null;
|
|
747
|
+
}
|
|
748
|
+
/**
|
|
749
|
+
* Informations to support actions on the connector.
|
|
750
|
+
*/
|
|
751
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ActionConfig {
|
|
752
|
+
/**
|
|
753
|
+
* Optional. Action parameters in structured json format.
|
|
754
|
+
*/
|
|
755
|
+
actionParams?: {
|
|
756
|
+
[key: string]: any;
|
|
757
|
+
} | null;
|
|
758
|
+
/**
|
|
759
|
+
* Output only. The connector contains the necessary parameters and is configured to support actions.
|
|
760
|
+
*/
|
|
761
|
+
isActionConfigured?: boolean | null;
|
|
762
|
+
/**
|
|
763
|
+
* Optional. Action parameters in json string format.
|
|
764
|
+
*/
|
|
765
|
+
jsonActionParams?: string | null;
|
|
766
|
+
/**
|
|
767
|
+
* Optional. The Service Directory resource name (projects/x/locations/x/namespaces/x/services/x) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.
|
|
768
|
+
*/
|
|
769
|
+
serviceName?: string | null;
|
|
770
|
+
/**
|
|
771
|
+
* Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.
|
|
772
|
+
*/
|
|
773
|
+
useStaticSecrets?: boolean | null;
|
|
774
|
+
}
|
|
735
775
|
/**
|
|
736
776
|
* Request message for CompletionService.AdvancedCompleteQuery method. .
|
|
737
777
|
*/
|
|
@@ -950,6 +990,72 @@ export declare namespace discoveryengine_v1 {
|
|
|
950
990
|
*/
|
|
951
991
|
disableInitialIndex?: boolean | null;
|
|
952
992
|
}
|
|
993
|
+
/**
|
|
994
|
+
* The connector level alert config.
|
|
995
|
+
*/
|
|
996
|
+
export interface Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfig {
|
|
997
|
+
/**
|
|
998
|
+
* Optional. The enrollment states of each alert.
|
|
999
|
+
*/
|
|
1000
|
+
alertEnrollments?: Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment[];
|
|
1001
|
+
/**
|
|
1002
|
+
* Immutable. The fully qualified resource name of the AlertPolicy.
|
|
1003
|
+
*/
|
|
1004
|
+
alertPolicyName?: string | null;
|
|
1005
|
+
}
|
|
1006
|
+
/**
|
|
1007
|
+
* The alert enrollment status.
|
|
1008
|
+
*/
|
|
1009
|
+
export interface Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment {
|
|
1010
|
+
/**
|
|
1011
|
+
* Immutable. The id of an alert.
|
|
1012
|
+
*/
|
|
1013
|
+
alertId?: string | null;
|
|
1014
|
+
/**
|
|
1015
|
+
* Required. The enrollment status of a customer.
|
|
1016
|
+
*/
|
|
1017
|
+
enrollState?: string | null;
|
|
1018
|
+
}
|
|
1019
|
+
/**
|
|
1020
|
+
* The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.
|
|
1021
|
+
*/
|
|
1022
|
+
export interface Schema$GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig {
|
|
1023
|
+
/**
|
|
1024
|
+
* Optional. The enrollment state of each alert.
|
|
1025
|
+
*/
|
|
1026
|
+
alertEnrollments?: Schema$GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment[];
|
|
1027
|
+
/**
|
|
1028
|
+
* Immutable. The fully qualified resource name of the AlertPolicy.
|
|
1029
|
+
*/
|
|
1030
|
+
alertPolicy?: string | null;
|
|
1031
|
+
/**
|
|
1032
|
+
* Optional. The contact details for each alert policy.
|
|
1033
|
+
*/
|
|
1034
|
+
contactDetails?: Schema$GoogleCloudDiscoveryengineV1ContactDetails[];
|
|
1035
|
+
/**
|
|
1036
|
+
* Optional. The language code used for notifications
|
|
1037
|
+
*/
|
|
1038
|
+
languageCode?: string | null;
|
|
1039
|
+
}
|
|
1040
|
+
/**
|
|
1041
|
+
* The alert enrollment status.
|
|
1042
|
+
*/
|
|
1043
|
+
export interface Schema$GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment {
|
|
1044
|
+
/**
|
|
1045
|
+
* Immutable. The id of an alert.
|
|
1046
|
+
*/
|
|
1047
|
+
alertId?: string | null;
|
|
1048
|
+
/**
|
|
1049
|
+
* Required. The enrollment status of a customer.
|
|
1050
|
+
*/
|
|
1051
|
+
enrollState?: string | null;
|
|
1052
|
+
/**
|
|
1053
|
+
* Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
|
|
1054
|
+
*/
|
|
1055
|
+
notificationParams?: {
|
|
1056
|
+
[key: string]: string;
|
|
1057
|
+
} | null;
|
|
1058
|
+
}
|
|
953
1059
|
/**
|
|
954
1060
|
* AlloyDB source import data from.
|
|
955
1061
|
*/
|
|
@@ -997,7 +1103,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
997
1103
|
*/
|
|
998
1104
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaActionConfig {
|
|
999
1105
|
/**
|
|
1000
|
-
*
|
|
1106
|
+
* Optional. Action parameters in structured json format.
|
|
1001
1107
|
*/
|
|
1002
1108
|
actionParams?: {
|
|
1003
1109
|
[key: string]: any;
|
|
@@ -1006,6 +1112,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
1006
1112
|
* Output only. The connector contains the necessary parameters and is configured to support actions.
|
|
1007
1113
|
*/
|
|
1008
1114
|
isActionConfigured?: boolean | null;
|
|
1115
|
+
/**
|
|
1116
|
+
* Optional. Action parameters in json string format.
|
|
1117
|
+
*/
|
|
1118
|
+
jsonActionParams?: string | null;
|
|
1009
1119
|
/**
|
|
1010
1120
|
* Optional. The Service Directory resource name (projects/x/locations/x/namespaces/x/services/x) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.
|
|
1011
1121
|
*/
|
|
@@ -1054,6 +1164,46 @@ export declare namespace discoveryengine_v1 {
|
|
|
1054
1164
|
*/
|
|
1055
1165
|
enrollState?: string | null;
|
|
1056
1166
|
}
|
|
1167
|
+
/**
|
|
1168
|
+
* The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.
|
|
1169
|
+
*/
|
|
1170
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig {
|
|
1171
|
+
/**
|
|
1172
|
+
* Optional. The enrollment state of each alert.
|
|
1173
|
+
*/
|
|
1174
|
+
alertEnrollments?: Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment[];
|
|
1175
|
+
/**
|
|
1176
|
+
* Immutable. The fully qualified resource name of the AlertPolicy.
|
|
1177
|
+
*/
|
|
1178
|
+
alertPolicy?: string | null;
|
|
1179
|
+
/**
|
|
1180
|
+
* Optional. The contact details for each alert policy.
|
|
1181
|
+
*/
|
|
1182
|
+
contactDetails?: Schema$GoogleCloudDiscoveryengineV1alphaContactDetails[];
|
|
1183
|
+
/**
|
|
1184
|
+
* Optional. The language code used for notifications
|
|
1185
|
+
*/
|
|
1186
|
+
languageCode?: string | null;
|
|
1187
|
+
}
|
|
1188
|
+
/**
|
|
1189
|
+
* The alert enrollment status.
|
|
1190
|
+
*/
|
|
1191
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment {
|
|
1192
|
+
/**
|
|
1193
|
+
* Immutable. The id of an alert.
|
|
1194
|
+
*/
|
|
1195
|
+
alertId?: string | null;
|
|
1196
|
+
/**
|
|
1197
|
+
* Required. The enrollment status of a customer.
|
|
1198
|
+
*/
|
|
1199
|
+
enrollState?: string | null;
|
|
1200
|
+
/**
|
|
1201
|
+
* Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
|
|
1202
|
+
*/
|
|
1203
|
+
notificationParams?: {
|
|
1204
|
+
[key: string]: string;
|
|
1205
|
+
} | null;
|
|
1206
|
+
}
|
|
1057
1207
|
/**
|
|
1058
1208
|
* Defines an answer.
|
|
1059
1209
|
*/
|
|
@@ -1468,10 +1618,274 @@ export declare namespace discoveryengine_v1 {
|
|
|
1468
1618
|
*/
|
|
1469
1619
|
query?: string | null;
|
|
1470
1620
|
}
|
|
1621
|
+
/**
|
|
1622
|
+
* AssistAnswer resource, main part of AssistResponse.
|
|
1623
|
+
*/
|
|
1624
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswer {
|
|
1625
|
+
/**
|
|
1626
|
+
* Reasons for not answering the assist call.
|
|
1627
|
+
*/
|
|
1628
|
+
assistSkippedReasons?: string[] | null;
|
|
1629
|
+
/**
|
|
1630
|
+
* Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation.
|
|
1631
|
+
*/
|
|
1632
|
+
customerPolicyEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult;
|
|
1633
|
+
/**
|
|
1634
|
+
* Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/assistAnswers/{assist_answer\}` This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
1635
|
+
*/
|
|
1636
|
+
name?: string | null;
|
|
1637
|
+
/**
|
|
1638
|
+
* Replies of the assistant.
|
|
1639
|
+
*/
|
|
1640
|
+
replies?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerReply[];
|
|
1641
|
+
/**
|
|
1642
|
+
* State of the answer generation.
|
|
1643
|
+
*/
|
|
1644
|
+
state?: string | null;
|
|
1645
|
+
}
|
|
1646
|
+
/**
|
|
1647
|
+
* Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks.
|
|
1648
|
+
*/
|
|
1649
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult {
|
|
1650
|
+
/**
|
|
1651
|
+
* Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query.
|
|
1652
|
+
*/
|
|
1653
|
+
policyResults?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult[];
|
|
1654
|
+
/**
|
|
1655
|
+
* Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK.
|
|
1656
|
+
*/
|
|
1657
|
+
verdict?: string | null;
|
|
1658
|
+
}
|
|
1659
|
+
/**
|
|
1660
|
+
* Customer policy enforcement result for the banned phrase policy.
|
|
1661
|
+
*/
|
|
1662
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult {
|
|
1663
|
+
/**
|
|
1664
|
+
* The banned phrases that were found in the query or the answer.
|
|
1665
|
+
*/
|
|
1666
|
+
bannedPhrases?: string[] | null;
|
|
1667
|
+
}
|
|
1668
|
+
/**
|
|
1669
|
+
* Customer policy enforcement result for the Model Armor policy.
|
|
1670
|
+
*/
|
|
1671
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult {
|
|
1672
|
+
/**
|
|
1673
|
+
* The error returned by Model Armor if the policy enforcement failed for some reason.
|
|
1674
|
+
*/
|
|
1675
|
+
error?: Schema$GoogleRpcStatus;
|
|
1676
|
+
/**
|
|
1677
|
+
* The Model Armor violation that was found.
|
|
1678
|
+
*/
|
|
1679
|
+
modelArmorViolation?: string | null;
|
|
1680
|
+
}
|
|
1681
|
+
/**
|
|
1682
|
+
* Customer policy enforcement result for a single policy type.
|
|
1683
|
+
*/
|
|
1684
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult {
|
|
1685
|
+
/**
|
|
1686
|
+
* The policy enforcement result for the banned phrase policy.
|
|
1687
|
+
*/
|
|
1688
|
+
bannedPhraseEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult;
|
|
1689
|
+
/**
|
|
1690
|
+
* The policy enforcement result for the Model Armor policy.
|
|
1691
|
+
*/
|
|
1692
|
+
modelArmorEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult;
|
|
1693
|
+
}
|
|
1694
|
+
/**
|
|
1695
|
+
* One part of the multi-part response of the assist call.
|
|
1696
|
+
*/
|
|
1697
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerReply {
|
|
1698
|
+
/**
|
|
1699
|
+
* Possibly grounded response text or media from the assistant.
|
|
1700
|
+
*/
|
|
1701
|
+
groundedContent?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent;
|
|
1702
|
+
/**
|
|
1703
|
+
* Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource.
|
|
1704
|
+
*/
|
|
1705
|
+
replyId?: string | null;
|
|
1706
|
+
}
|
|
1707
|
+
/**
|
|
1708
|
+
* Multi-modal content.
|
|
1709
|
+
*/
|
|
1710
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantContent {
|
|
1711
|
+
/**
|
|
1712
|
+
* Result of executing an ExecutableCode.
|
|
1713
|
+
*/
|
|
1714
|
+
codeExecutionResult?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult;
|
|
1715
|
+
/**
|
|
1716
|
+
* Code generated by the model that is meant to be executed.
|
|
1717
|
+
*/
|
|
1718
|
+
executableCode?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode;
|
|
1719
|
+
/**
|
|
1720
|
+
* A file, e.g., an audio summary.
|
|
1721
|
+
*/
|
|
1722
|
+
file?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantContentFile;
|
|
1723
|
+
/**
|
|
1724
|
+
* Inline binary data.
|
|
1725
|
+
*/
|
|
1726
|
+
inlineData?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantContentBlob;
|
|
1727
|
+
/**
|
|
1728
|
+
* The producer of the content. Can be "model" or "user".
|
|
1729
|
+
*/
|
|
1730
|
+
role?: string | null;
|
|
1731
|
+
/**
|
|
1732
|
+
* Inline text.
|
|
1733
|
+
*/
|
|
1734
|
+
text?: string | null;
|
|
1735
|
+
/**
|
|
1736
|
+
* Optional. Indicates if the part is thought from the model.
|
|
1737
|
+
*/
|
|
1738
|
+
thought?: boolean | null;
|
|
1739
|
+
}
|
|
1740
|
+
/**
|
|
1741
|
+
* Inline blob.
|
|
1742
|
+
*/
|
|
1743
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantContentBlob {
|
|
1744
|
+
/**
|
|
1745
|
+
* Required. Raw bytes.
|
|
1746
|
+
*/
|
|
1747
|
+
data?: string | null;
|
|
1748
|
+
/**
|
|
1749
|
+
* Required. The media type (MIME type) of the generated data.
|
|
1750
|
+
*/
|
|
1751
|
+
mimeType?: string | null;
|
|
1752
|
+
}
|
|
1753
|
+
/**
|
|
1754
|
+
* Result of executing ExecutableCode.
|
|
1755
|
+
*/
|
|
1756
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult {
|
|
1757
|
+
/**
|
|
1758
|
+
* Required. Outcome of the code execution.
|
|
1759
|
+
*/
|
|
1760
|
+
outcome?: string | null;
|
|
1761
|
+
/**
|
|
1762
|
+
* Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
|
|
1763
|
+
*/
|
|
1764
|
+
output?: string | null;
|
|
1765
|
+
}
|
|
1766
|
+
/**
|
|
1767
|
+
* Code generated by the model that is meant to be executed by the model.
|
|
1768
|
+
*/
|
|
1769
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode {
|
|
1770
|
+
/**
|
|
1771
|
+
* Required. The code content. Currently only supports Python.
|
|
1772
|
+
*/
|
|
1773
|
+
code?: string | null;
|
|
1774
|
+
}
|
|
1775
|
+
/**
|
|
1776
|
+
* A file, e.g., an audio summary.
|
|
1777
|
+
*/
|
|
1778
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantContentFile {
|
|
1779
|
+
/**
|
|
1780
|
+
* Required. The file ID.
|
|
1781
|
+
*/
|
|
1782
|
+
fileId?: string | null;
|
|
1783
|
+
/**
|
|
1784
|
+
* Required. The media type (MIME type) of the file.
|
|
1785
|
+
*/
|
|
1786
|
+
mimeType?: string | null;
|
|
1787
|
+
}
|
|
1788
|
+
/**
|
|
1789
|
+
* A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding.
|
|
1790
|
+
*/
|
|
1791
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent {
|
|
1792
|
+
/**
|
|
1793
|
+
* The content.
|
|
1794
|
+
*/
|
|
1795
|
+
content?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantContent;
|
|
1796
|
+
/**
|
|
1797
|
+
* Metadata for grounding based on text sources.
|
|
1798
|
+
*/
|
|
1799
|
+
textGroundingMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata;
|
|
1800
|
+
}
|
|
1801
|
+
/**
|
|
1802
|
+
* Grounding details for text sources.
|
|
1803
|
+
*/
|
|
1804
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata {
|
|
1805
|
+
/**
|
|
1806
|
+
* References for the grounded text.
|
|
1807
|
+
*/
|
|
1808
|
+
references?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference[];
|
|
1809
|
+
/**
|
|
1810
|
+
* Grounding information for parts of the text.
|
|
1811
|
+
*/
|
|
1812
|
+
segments?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment[];
|
|
1813
|
+
}
|
|
1814
|
+
/**
|
|
1815
|
+
* Referenced content and related document metadata.
|
|
1816
|
+
*/
|
|
1817
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference {
|
|
1818
|
+
/**
|
|
1819
|
+
* Referenced text content.
|
|
1820
|
+
*/
|
|
1821
|
+
content?: string | null;
|
|
1822
|
+
/**
|
|
1823
|
+
* Document metadata.
|
|
1824
|
+
*/
|
|
1825
|
+
documentMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata;
|
|
1826
|
+
}
|
|
1827
|
+
/**
|
|
1828
|
+
* Document metadata.
|
|
1829
|
+
*/
|
|
1830
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata {
|
|
1831
|
+
/**
|
|
1832
|
+
* Document resource name.
|
|
1833
|
+
*/
|
|
1834
|
+
document?: string | null;
|
|
1835
|
+
/**
|
|
1836
|
+
* Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.
|
|
1837
|
+
*/
|
|
1838
|
+
domain?: string | null;
|
|
1839
|
+
/**
|
|
1840
|
+
* The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.
|
|
1841
|
+
*/
|
|
1842
|
+
mimeType?: string | null;
|
|
1843
|
+
/**
|
|
1844
|
+
* Page identifier.
|
|
1845
|
+
*/
|
|
1846
|
+
pageIdentifier?: string | null;
|
|
1847
|
+
/**
|
|
1848
|
+
* Title.
|
|
1849
|
+
*/
|
|
1850
|
+
title?: string | null;
|
|
1851
|
+
/**
|
|
1852
|
+
* URI for the document. It may contain a URL that redirects to the actual website.
|
|
1853
|
+
*/
|
|
1854
|
+
uri?: string | null;
|
|
1855
|
+
}
|
|
1856
|
+
/**
|
|
1857
|
+
* Grounding information for a segment of the text.
|
|
1858
|
+
*/
|
|
1859
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment {
|
|
1860
|
+
/**
|
|
1861
|
+
* End of the segment, exclusive.
|
|
1862
|
+
*/
|
|
1863
|
+
endIndex?: string | null;
|
|
1864
|
+
/**
|
|
1865
|
+
* Score for the segment.
|
|
1866
|
+
*/
|
|
1867
|
+
groundingScore?: number | null;
|
|
1868
|
+
/**
|
|
1869
|
+
* References for the segment.
|
|
1870
|
+
*/
|
|
1871
|
+
referenceIndices?: number[] | null;
|
|
1872
|
+
/**
|
|
1873
|
+
* Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one).
|
|
1874
|
+
*/
|
|
1875
|
+
startIndex?: string | null;
|
|
1876
|
+
/**
|
|
1877
|
+
* The text segment itself.
|
|
1878
|
+
*/
|
|
1879
|
+
text?: string | null;
|
|
1880
|
+
}
|
|
1471
1881
|
/**
|
|
1472
1882
|
* The configuration for the BAP connector.
|
|
1473
1883
|
*/
|
|
1474
1884
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaBAPConfig {
|
|
1885
|
+
/**
|
|
1886
|
+
* Optional. The actions enabled on the associated BAP connection.
|
|
1887
|
+
*/
|
|
1888
|
+
enabledActions?: string[] | null;
|
|
1475
1889
|
/**
|
|
1476
1890
|
* Required. The supported connector modes for the associated BAP connection.
|
|
1477
1891
|
*/
|
|
@@ -1749,6 +2163,15 @@ export declare namespace discoveryengine_v1 {
|
|
|
1749
2163
|
*/
|
|
1750
2164
|
totalCount?: string | null;
|
|
1751
2165
|
}
|
|
2166
|
+
/**
|
|
2167
|
+
* The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
|
|
2168
|
+
*/
|
|
2169
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaContactDetails {
|
|
2170
|
+
/**
|
|
2171
|
+
* Optional. The email address of the contact.
|
|
2172
|
+
*/
|
|
2173
|
+
emailAddress?: string | null;
|
|
2174
|
+
}
|
|
1752
2175
|
/**
|
|
1753
2176
|
* Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.
|
|
1754
2177
|
*/
|
|
@@ -2057,6 +2480,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
2057
2480
|
* Output only. The errors from initialization or from the latest connector run.
|
|
2058
2481
|
*/
|
|
2059
2482
|
errors?: Schema$GoogleRpcStatus[];
|
|
2483
|
+
/**
|
|
2484
|
+
* Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode.
|
|
2485
|
+
*/
|
|
2486
|
+
federatedConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig;
|
|
2060
2487
|
/**
|
|
2061
2488
|
* Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.
|
|
2062
2489
|
*/
|
|
@@ -2077,6 +2504,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
2077
2504
|
* Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.
|
|
2078
2505
|
*/
|
|
2079
2506
|
incrementalSyncDisabled?: boolean | null;
|
|
2507
|
+
/**
|
|
2508
|
+
* Required data connector parameters in json string format.
|
|
2509
|
+
*/
|
|
2510
|
+
jsonParams?: string | null;
|
|
2080
2511
|
/**
|
|
2081
2512
|
* Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
|
|
2082
2513
|
*/
|
|
@@ -2098,7 +2529,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
2098
2529
|
*/
|
|
2099
2530
|
nextSyncTime?: Schema$GoogleTypeDateTime;
|
|
2100
2531
|
/**
|
|
2101
|
-
* Required
|
|
2532
|
+
* Required data connector parameters in structured json format.
|
|
2102
2533
|
*/
|
|
2103
2534
|
params?: {
|
|
2104
2535
|
[key: string]: any;
|
|
@@ -2119,6 +2550,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
2119
2550
|
* Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
|
|
2120
2551
|
*/
|
|
2121
2552
|
refreshInterval?: string | null;
|
|
2553
|
+
/**
|
|
2554
|
+
* Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.
|
|
2555
|
+
*/
|
|
2556
|
+
removeParamKeys?: string[] | null;
|
|
2122
2557
|
/**
|
|
2123
2558
|
* Output only. State of the connector.
|
|
2124
2559
|
*/
|
|
@@ -2156,11 +2591,36 @@ export declare namespace discoveryengine_v1 {
|
|
|
2156
2591
|
authParams?: {
|
|
2157
2592
|
[key: string]: any;
|
|
2158
2593
|
} | null;
|
|
2594
|
+
/**
|
|
2595
|
+
* Optional. Any authentication parameters specific to EUA connectors in json string format.
|
|
2596
|
+
*/
|
|
2597
|
+
jsonAuthParams?: string | null;
|
|
2159
2598
|
/**
|
|
2160
2599
|
* Optional. The tenant project the connector is connected to.
|
|
2161
2600
|
*/
|
|
2162
2601
|
tenant?: Schema$GoogleCloudDiscoveryengineV1alphaTenant;
|
|
2163
2602
|
}
|
|
2603
|
+
/**
|
|
2604
|
+
* Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.
|
|
2605
|
+
*/
|
|
2606
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig {
|
|
2607
|
+
/**
|
|
2608
|
+
* Optional. Any additional parameters needed for FEDERATED.
|
|
2609
|
+
*/
|
|
2610
|
+
additionalParams?: {
|
|
2611
|
+
[key: string]: any;
|
|
2612
|
+
} | null;
|
|
2613
|
+
/**
|
|
2614
|
+
* Optional. Any authentication parameters specific to FEDERATED connectors.
|
|
2615
|
+
*/
|
|
2616
|
+
authParams?: {
|
|
2617
|
+
[key: string]: any;
|
|
2618
|
+
} | null;
|
|
2619
|
+
/**
|
|
2620
|
+
* Optional. Any authentication parameters specific to FEDERATED connectors in json string format.
|
|
2621
|
+
*/
|
|
2622
|
+
jsonAuthParams?: string | null;
|
|
2623
|
+
}
|
|
2164
2624
|
/**
|
|
2165
2625
|
* The configuration for realtime sync to store additional params for realtime sync.
|
|
2166
2626
|
*/
|
|
@@ -2207,6 +2667,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
2207
2667
|
* Optional. Configuration for `HEALTHCARE_FHIR` vertical.
|
|
2208
2668
|
*/
|
|
2209
2669
|
healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig;
|
|
2670
|
+
/**
|
|
2671
|
+
* The parameters for the entity to facilitate data ingestion in json string format.
|
|
2672
|
+
*/
|
|
2673
|
+
jsonParams?: string | null;
|
|
2210
2674
|
/**
|
|
2211
2675
|
* Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.
|
|
2212
2676
|
*/
|
|
@@ -2214,7 +2678,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
2214
2678
|
[key: string]: string;
|
|
2215
2679
|
} | null;
|
|
2216
2680
|
/**
|
|
2217
|
-
* The parameters for the entity to facilitate data ingestion
|
|
2681
|
+
* The parameters for the entity to facilitate data ingestion in structured json format.
|
|
2218
2682
|
*/
|
|
2219
2683
|
params?: {
|
|
2220
2684
|
[key: string]: any;
|
|
@@ -2244,6 +2708,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
2244
2708
|
* Output only. CMEK-related information for the DataStore.
|
|
2245
2709
|
*/
|
|
2246
2710
|
cmekConfig?: Schema$GoogleCloudDiscoveryengineV1alphaCmekConfig;
|
|
2711
|
+
/**
|
|
2712
|
+
* Optional. Configuration for configurable billing approach. See
|
|
2713
|
+
*/
|
|
2714
|
+
configurableBillingApproach?: string | null;
|
|
2247
2715
|
/**
|
|
2248
2716
|
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
2249
2717
|
*/
|
|
@@ -2497,12 +2965,16 @@ export declare namespace discoveryengine_v1 {
|
|
|
2497
2965
|
* Optional. The destinations for the corresponding key.
|
|
2498
2966
|
*/
|
|
2499
2967
|
destinations?: Schema$GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination[];
|
|
2968
|
+
/**
|
|
2969
|
+
* Additional parameters for this destination config in json string format.
|
|
2970
|
+
*/
|
|
2971
|
+
jsonParams?: string | null;
|
|
2500
2972
|
/**
|
|
2501
2973
|
* Optional. Unique destination identifier that is supported by the connector.
|
|
2502
2974
|
*/
|
|
2503
2975
|
key?: string | null;
|
|
2504
2976
|
/**
|
|
2505
|
-
* Optional. Additional parameters for this destination config.
|
|
2977
|
+
* Optional. Additional parameters for this destination config in structured json format.
|
|
2506
2978
|
*/
|
|
2507
2979
|
params?: {
|
|
2508
2980
|
[key: string]: any;
|
|
@@ -2674,6 +3146,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
2674
3146
|
* Metadata that describes the training and serving parameters of an Engine.
|
|
2675
3147
|
*/
|
|
2676
3148
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngine {
|
|
3149
|
+
/**
|
|
3150
|
+
* Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.
|
|
3151
|
+
*/
|
|
3152
|
+
appType?: string | null;
|
|
2677
3153
|
/**
|
|
2678
3154
|
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
2679
3155
|
*/
|
|
@@ -2686,6 +3162,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
2686
3162
|
* Common config spec that specifies the metadata of the engine.
|
|
2687
3163
|
*/
|
|
2688
3164
|
commonConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineCommonConfig;
|
|
3165
|
+
/**
|
|
3166
|
+
* Optional. Configuration for configurable billing approach.
|
|
3167
|
+
*/
|
|
3168
|
+
configurableBillingApproach?: string | null;
|
|
2689
3169
|
/**
|
|
2690
3170
|
* Output only. Timestamp the Recommendation Engine was created at.
|
|
2691
3171
|
*/
|
|
@@ -2703,7 +3183,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
2703
3183
|
*/
|
|
2704
3184
|
displayName?: string | null;
|
|
2705
3185
|
/**
|
|
2706
|
-
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` -
|
|
3186
|
+
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
|
|
2707
3187
|
*/
|
|
2708
3188
|
features?: {
|
|
2709
3189
|
[key: string]: string;
|
|
@@ -3394,6 +3874,51 @@ export declare namespace discoveryengine_v1 {
|
|
|
3394
3874
|
*/
|
|
3395
3875
|
region?: string | null;
|
|
3396
3876
|
}
|
|
3877
|
+
/**
|
|
3878
|
+
* Information about users' licenses.
|
|
3879
|
+
*/
|
|
3880
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaLicenseConfig {
|
|
3881
|
+
/**
|
|
3882
|
+
* Optional. The alert policy config for this license config.
|
|
3883
|
+
*/
|
|
3884
|
+
alertPolicyResourceConfig?: Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig;
|
|
3885
|
+
/**
|
|
3886
|
+
* Optional. Whether the license config should be auto renewed when it reaches the end date.
|
|
3887
|
+
*/
|
|
3888
|
+
autoRenew?: boolean | null;
|
|
3889
|
+
/**
|
|
3890
|
+
* Optional. The planed end date.
|
|
3891
|
+
*/
|
|
3892
|
+
endDate?: Schema$GoogleTypeDate;
|
|
3893
|
+
/**
|
|
3894
|
+
* Optional. Whether the license config is for free trial.
|
|
3895
|
+
*/
|
|
3896
|
+
freeTrial?: boolean | null;
|
|
3897
|
+
/**
|
|
3898
|
+
* Required. Number of licenses purchased.
|
|
3899
|
+
*/
|
|
3900
|
+
licenseCount?: string | null;
|
|
3901
|
+
/**
|
|
3902
|
+
* Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}`
|
|
3903
|
+
*/
|
|
3904
|
+
name?: string | null;
|
|
3905
|
+
/**
|
|
3906
|
+
* Required. The start date.
|
|
3907
|
+
*/
|
|
3908
|
+
startDate?: Schema$GoogleTypeDate;
|
|
3909
|
+
/**
|
|
3910
|
+
* Output only. The state of the license config.
|
|
3911
|
+
*/
|
|
3912
|
+
state?: string | null;
|
|
3913
|
+
/**
|
|
3914
|
+
* Required. Subscription term.
|
|
3915
|
+
*/
|
|
3916
|
+
subscriptionTerm?: string | null;
|
|
3917
|
+
/**
|
|
3918
|
+
* Required. Subscription tier information for the license config.
|
|
3919
|
+
*/
|
|
3920
|
+
subscriptionTier?: string | null;
|
|
3921
|
+
}
|
|
3397
3922
|
/**
|
|
3398
3923
|
* Request for ListSessions method.
|
|
3399
3924
|
*/
|
|
@@ -3483,6 +4008,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
3483
4008
|
* Output only. The timestamp when this project is created.
|
|
3484
4009
|
*/
|
|
3485
4010
|
createTime?: string | null;
|
|
4011
|
+
/**
|
|
4012
|
+
* Optional. Customer provided configurations.
|
|
4013
|
+
*/
|
|
4014
|
+
customerProvidedConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig;
|
|
3486
4015
|
/**
|
|
3487
4016
|
* Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
|
|
3488
4017
|
*/
|
|
@@ -3498,6 +4027,37 @@ export declare namespace discoveryengine_v1 {
|
|
|
3498
4027
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms;
|
|
3499
4028
|
} | null;
|
|
3500
4029
|
}
|
|
4030
|
+
/**
|
|
4031
|
+
* Customer provided configurations.
|
|
4032
|
+
*/
|
|
4033
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig {
|
|
4034
|
+
/**
|
|
4035
|
+
* Optional. Configuration for NotebookLM settings.
|
|
4036
|
+
*/
|
|
4037
|
+
notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig;
|
|
4038
|
+
}
|
|
4039
|
+
/**
|
|
4040
|
+
* Configuration for NotebookLM.
|
|
4041
|
+
*/
|
|
4042
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig {
|
|
4043
|
+
/**
|
|
4044
|
+
* Model Armor configuration to be used for sanitizing user prompts and LLM responses.
|
|
4045
|
+
*/
|
|
4046
|
+
modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
|
|
4047
|
+
}
|
|
4048
|
+
/**
|
|
4049
|
+
* Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
|
|
4050
|
+
*/
|
|
4051
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig {
|
|
4052
|
+
/**
|
|
4053
|
+
* Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the LLM response.
|
|
4054
|
+
*/
|
|
4055
|
+
responseTemplate?: string | null;
|
|
4056
|
+
/**
|
|
4057
|
+
* Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the user prompt.
|
|
4058
|
+
*/
|
|
4059
|
+
userPromptTemplate?: string | null;
|
|
4060
|
+
}
|
|
3501
4061
|
/**
|
|
3502
4062
|
* Metadata about the terms of service.
|
|
3503
4063
|
*/
|
|
@@ -3959,11 +4519,11 @@ export declare namespace discoveryengine_v1 {
|
|
|
3959
4519
|
*/
|
|
3960
4520
|
languageCode?: string | null;
|
|
3961
4521
|
/**
|
|
3962
|
-
* Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
|
|
4522
|
+
* Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
|
|
3963
4523
|
*/
|
|
3964
4524
|
naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec;
|
|
3965
4525
|
/**
|
|
3966
|
-
* A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
|
|
4526
|
+
* A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
|
|
3967
4527
|
*/
|
|
3968
4528
|
offset?: number | null;
|
|
3969
4529
|
/**
|
|
@@ -4024,6 +4584,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
4024
4584
|
* Whether to turn on safe search. This is only supported for website search.
|
|
4025
4585
|
*/
|
|
4026
4586
|
safeSearch?: boolean | null;
|
|
4587
|
+
/**
|
|
4588
|
+
* Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests.
|
|
4589
|
+
*/
|
|
4590
|
+
searchAddonSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec;
|
|
4027
4591
|
/**
|
|
4028
4592
|
* Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
|
|
4029
4593
|
*/
|
|
@@ -4398,6 +4962,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
4398
4962
|
* Specification to enable natural language understanding capabilities for search requests.
|
|
4399
4963
|
*/
|
|
4400
4964
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec {
|
|
4965
|
+
/**
|
|
4966
|
+
* Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
|
|
4967
|
+
*/
|
|
4968
|
+
allowedFieldNames?: string[] | null;
|
|
4401
4969
|
/**
|
|
4402
4970
|
* Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
|
|
4403
4971
|
*/
|
|
@@ -4442,6 +5010,23 @@ export declare namespace discoveryengine_v1 {
|
|
|
4442
5010
|
*/
|
|
4443
5011
|
returnRelevanceScore?: boolean | null;
|
|
4444
5012
|
}
|
|
5013
|
+
/**
|
|
5014
|
+
* SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.
|
|
5015
|
+
*/
|
|
5016
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec {
|
|
5017
|
+
/**
|
|
5018
|
+
* Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
|
|
5019
|
+
*/
|
|
5020
|
+
disableGenerativeAnswerAddOn?: boolean | null;
|
|
5021
|
+
/**
|
|
5022
|
+
* Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
|
|
5023
|
+
*/
|
|
5024
|
+
disableKpiPersonalizationAddOn?: boolean | null;
|
|
5025
|
+
/**
|
|
5026
|
+
* Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
|
|
5027
|
+
*/
|
|
5028
|
+
disableSemanticAddOn?: boolean | null;
|
|
5029
|
+
}
|
|
4445
5030
|
/**
|
|
4446
5031
|
* Specification for search as you type in search requests.
|
|
4447
5032
|
*/
|
|
@@ -4522,6 +5107,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
4522
5107
|
* Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.
|
|
4523
5108
|
*/
|
|
4524
5109
|
detailedAnswer?: Schema$GoogleCloudDiscoveryengineV1alphaAnswer;
|
|
5110
|
+
/**
|
|
5111
|
+
* Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session.
|
|
5112
|
+
*/
|
|
5113
|
+
detailedAssistAnswer?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswer;
|
|
4525
5114
|
/**
|
|
4526
5115
|
* Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
|
|
4527
5116
|
*/
|
|
@@ -5750,6 +6339,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
5750
6339
|
* Reasons for not answering the assist call.
|
|
5751
6340
|
*/
|
|
5752
6341
|
assistSkippedReasons?: string[] | null;
|
|
6342
|
+
/**
|
|
6343
|
+
* Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation.
|
|
6344
|
+
*/
|
|
6345
|
+
customerPolicyEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResult;
|
|
5753
6346
|
/**
|
|
5754
6347
|
* Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/assistAnswers/{assist_answer\}` This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
5755
6348
|
*/
|
|
@@ -5763,6 +6356,54 @@ export declare namespace discoveryengine_v1 {
|
|
|
5763
6356
|
*/
|
|
5764
6357
|
state?: string | null;
|
|
5765
6358
|
}
|
|
6359
|
+
/**
|
|
6360
|
+
* Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks.
|
|
6361
|
+
*/
|
|
6362
|
+
export interface Schema$GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResult {
|
|
6363
|
+
/**
|
|
6364
|
+
* Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query.
|
|
6365
|
+
*/
|
|
6366
|
+
policyResults?: Schema$GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult[];
|
|
6367
|
+
/**
|
|
6368
|
+
* Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK.
|
|
6369
|
+
*/
|
|
6370
|
+
verdict?: string | null;
|
|
6371
|
+
}
|
|
6372
|
+
/**
|
|
6373
|
+
* Customer policy enforcement result for the banned phrase policy.
|
|
6374
|
+
*/
|
|
6375
|
+
export interface Schema$GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult {
|
|
6376
|
+
/**
|
|
6377
|
+
* The banned phrases that were found in the query or the answer.
|
|
6378
|
+
*/
|
|
6379
|
+
bannedPhrases?: string[] | null;
|
|
6380
|
+
}
|
|
6381
|
+
/**
|
|
6382
|
+
* Customer policy enforcement result for the Model Armor policy.
|
|
6383
|
+
*/
|
|
6384
|
+
export interface Schema$GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult {
|
|
6385
|
+
/**
|
|
6386
|
+
* The error returned by Model Armor if the policy enforcement failed for some reason.
|
|
6387
|
+
*/
|
|
6388
|
+
error?: Schema$GoogleRpcStatus;
|
|
6389
|
+
/**
|
|
6390
|
+
* The Model Armor violation that was found.
|
|
6391
|
+
*/
|
|
6392
|
+
modelArmorViolation?: string | null;
|
|
6393
|
+
}
|
|
6394
|
+
/**
|
|
6395
|
+
* Customer policy enforcement result for a single policy type.
|
|
6396
|
+
*/
|
|
6397
|
+
export interface Schema$GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult {
|
|
6398
|
+
/**
|
|
6399
|
+
* The policy enforcement result for the banned phrase policy.
|
|
6400
|
+
*/
|
|
6401
|
+
bannedPhraseEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult;
|
|
6402
|
+
/**
|
|
6403
|
+
* The policy enforcement result for the Model Armor policy.
|
|
6404
|
+
*/
|
|
6405
|
+
modelArmorEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult;
|
|
6406
|
+
}
|
|
5766
6407
|
/**
|
|
5767
6408
|
* One part of the multi-part response of the assist call.
|
|
5768
6409
|
*/
|
|
@@ -5888,6 +6529,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
5888
6529
|
* Optional. List of banned phrases.
|
|
5889
6530
|
*/
|
|
5890
6531
|
bannedPhrases?: Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase[];
|
|
6532
|
+
/**
|
|
6533
|
+
* Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses.
|
|
6534
|
+
*/
|
|
6535
|
+
modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig;
|
|
5891
6536
|
}
|
|
5892
6537
|
/**
|
|
5893
6538
|
* Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused.
|
|
@@ -5906,6 +6551,23 @@ export declare namespace discoveryengine_v1 {
|
|
|
5906
6551
|
*/
|
|
5907
6552
|
phrase?: string | null;
|
|
5908
6553
|
}
|
|
6554
|
+
/**
|
|
6555
|
+
* Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses.
|
|
6556
|
+
*/
|
|
6557
|
+
export interface Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig {
|
|
6558
|
+
/**
|
|
6559
|
+
* Optional. Defines the failure mode for Model Armor sanitization.
|
|
6560
|
+
*/
|
|
6561
|
+
failureMode?: string | null;
|
|
6562
|
+
/**
|
|
6563
|
+
* Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project\}/locations/{location\}/templates/{template_id\}` If not specified, no sanitization will be applied to the assistant response.
|
|
6564
|
+
*/
|
|
6565
|
+
responseTemplate?: string | null;
|
|
6566
|
+
/**
|
|
6567
|
+
* Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project\}/locations/{location\}/templates/{template_id\}` If not specified, no sanitization will be applied to the user prompt.
|
|
6568
|
+
*/
|
|
6569
|
+
userPromptTemplate?: string | null;
|
|
6570
|
+
}
|
|
5909
6571
|
/**
|
|
5910
6572
|
* Configuration for the generation of the assistant response.
|
|
5911
6573
|
*/
|
|
@@ -5979,6 +6641,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
5979
6641
|
* Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.
|
|
5980
6642
|
*/
|
|
5981
6643
|
domain?: string | null;
|
|
6644
|
+
/**
|
|
6645
|
+
* The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.
|
|
6646
|
+
*/
|
|
6647
|
+
mimeType?: string | null;
|
|
5982
6648
|
/**
|
|
5983
6649
|
* Page identifier.
|
|
5984
6650
|
*/
|
|
@@ -6052,6 +6718,19 @@ export declare namespace discoveryengine_v1 {
|
|
|
6052
6718
|
*/
|
|
6053
6719
|
timeZone?: string | null;
|
|
6054
6720
|
}
|
|
6721
|
+
/**
|
|
6722
|
+
* The configuration for the BAP connector.
|
|
6723
|
+
*/
|
|
6724
|
+
export interface Schema$GoogleCloudDiscoveryengineV1BAPConfig {
|
|
6725
|
+
/**
|
|
6726
|
+
* Optional. The actions enabled on the associated BAP connection.
|
|
6727
|
+
*/
|
|
6728
|
+
enabledActions?: string[] | null;
|
|
6729
|
+
/**
|
|
6730
|
+
* Required. The supported connector modes for the associated BAP connection.
|
|
6731
|
+
*/
|
|
6732
|
+
supportedConnectorModes?: string[] | null;
|
|
6733
|
+
}
|
|
6055
6734
|
/**
|
|
6056
6735
|
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
6057
6736
|
*/
|
|
@@ -6191,6 +6870,19 @@ export declare namespace discoveryengine_v1 {
|
|
|
6191
6870
|
*/
|
|
6192
6871
|
export interface Schema$GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest {
|
|
6193
6872
|
}
|
|
6873
|
+
/**
|
|
6874
|
+
* Access Control Configuration.
|
|
6875
|
+
*/
|
|
6876
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAclConfig {
|
|
6877
|
+
/**
|
|
6878
|
+
* Identity provider config.
|
|
6879
|
+
*/
|
|
6880
|
+
idpConfig?: Schema$GoogleCloudDiscoveryengineV1betaIdpConfig;
|
|
6881
|
+
/**
|
|
6882
|
+
* Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
6883
|
+
*/
|
|
6884
|
+
name?: string | null;
|
|
6885
|
+
}
|
|
6194
6886
|
/**
|
|
6195
6887
|
* Configuration data for advance site search.
|
|
6196
6888
|
*/
|
|
@@ -6204,6 +6896,46 @@ export declare namespace discoveryengine_v1 {
|
|
|
6204
6896
|
*/
|
|
6205
6897
|
disableInitialIndex?: boolean | null;
|
|
6206
6898
|
}
|
|
6899
|
+
/**
|
|
6900
|
+
* The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.
|
|
6901
|
+
*/
|
|
6902
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig {
|
|
6903
|
+
/**
|
|
6904
|
+
* Optional. The enrollment state of each alert.
|
|
6905
|
+
*/
|
|
6906
|
+
alertEnrollments?: Schema$GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment[];
|
|
6907
|
+
/**
|
|
6908
|
+
* Immutable. The fully qualified resource name of the AlertPolicy.
|
|
6909
|
+
*/
|
|
6910
|
+
alertPolicy?: string | null;
|
|
6911
|
+
/**
|
|
6912
|
+
* Optional. The contact details for each alert policy.
|
|
6913
|
+
*/
|
|
6914
|
+
contactDetails?: Schema$GoogleCloudDiscoveryengineV1betaContactDetails[];
|
|
6915
|
+
/**
|
|
6916
|
+
* Optional. The language code used for notifications
|
|
6917
|
+
*/
|
|
6918
|
+
languageCode?: string | null;
|
|
6919
|
+
}
|
|
6920
|
+
/**
|
|
6921
|
+
* The alert enrollment status.
|
|
6922
|
+
*/
|
|
6923
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment {
|
|
6924
|
+
/**
|
|
6925
|
+
* Immutable. The id of an alert.
|
|
6926
|
+
*/
|
|
6927
|
+
alertId?: string | null;
|
|
6928
|
+
/**
|
|
6929
|
+
* Required. The enrollment status of a customer.
|
|
6930
|
+
*/
|
|
6931
|
+
enrollState?: string | null;
|
|
6932
|
+
/**
|
|
6933
|
+
* Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
|
|
6934
|
+
*/
|
|
6935
|
+
notificationParams?: {
|
|
6936
|
+
[key: string]: string;
|
|
6937
|
+
} | null;
|
|
6938
|
+
}
|
|
6207
6939
|
/**
|
|
6208
6940
|
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
6209
6941
|
*/
|
|
@@ -6340,6 +7072,15 @@ export declare namespace discoveryengine_v1 {
|
|
|
6340
7072
|
*/
|
|
6341
7073
|
startTime?: string | null;
|
|
6342
7074
|
}
|
|
7075
|
+
/**
|
|
7076
|
+
* The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
|
|
7077
|
+
*/
|
|
7078
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaContactDetails {
|
|
7079
|
+
/**
|
|
7080
|
+
* Optional. The email address of the contact.
|
|
7081
|
+
*/
|
|
7082
|
+
emailAddress?: string | null;
|
|
7083
|
+
}
|
|
6343
7084
|
/**
|
|
6344
7085
|
* Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.
|
|
6345
7086
|
*/
|
|
@@ -6591,6 +7332,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
6591
7332
|
* Output only. CMEK-related information for the DataStore.
|
|
6592
7333
|
*/
|
|
6593
7334
|
cmekConfig?: Schema$GoogleCloudDiscoveryengineV1betaCmekConfig;
|
|
7335
|
+
/**
|
|
7336
|
+
* Optional. Configuration for configurable billing approach. See
|
|
7337
|
+
*/
|
|
7338
|
+
configurableBillingApproach?: string | null;
|
|
6594
7339
|
/**
|
|
6595
7340
|
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
6596
7341
|
*/
|
|
@@ -6950,6 +7695,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
6950
7695
|
* Metadata that describes the training and serving parameters of an Engine.
|
|
6951
7696
|
*/
|
|
6952
7697
|
export interface Schema$GoogleCloudDiscoveryengineV1betaEngine {
|
|
7698
|
+
/**
|
|
7699
|
+
* Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.
|
|
7700
|
+
*/
|
|
7701
|
+
appType?: string | null;
|
|
6953
7702
|
/**
|
|
6954
7703
|
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
6955
7704
|
*/
|
|
@@ -6962,6 +7711,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
6962
7711
|
* Common config spec that specifies the metadata of the engine.
|
|
6963
7712
|
*/
|
|
6964
7713
|
commonConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig;
|
|
7714
|
+
/**
|
|
7715
|
+
* Optional. Configuration for configurable billing approach.
|
|
7716
|
+
*/
|
|
7717
|
+
configurableBillingApproach?: string | null;
|
|
6965
7718
|
/**
|
|
6966
7719
|
* Output only. Timestamp the Recommendation Engine was created at.
|
|
6967
7720
|
*/
|
|
@@ -6979,7 +7732,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
6979
7732
|
*/
|
|
6980
7733
|
displayName?: string | null;
|
|
6981
7734
|
/**
|
|
6982
|
-
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` -
|
|
7735
|
+
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
|
|
6983
7736
|
*/
|
|
6984
7737
|
features?: {
|
|
6985
7738
|
[key: string]: string;
|
|
@@ -7236,6 +7989,28 @@ export declare namespace discoveryengine_v1 {
|
|
|
7236
7989
|
*/
|
|
7237
7990
|
totalCount?: string | null;
|
|
7238
7991
|
}
|
|
7992
|
+
/**
|
|
7993
|
+
* Identity Provider Config.
|
|
7994
|
+
*/
|
|
7995
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaIdpConfig {
|
|
7996
|
+
/**
|
|
7997
|
+
* External Identity provider config.
|
|
7998
|
+
*/
|
|
7999
|
+
externalIdpConfig?: Schema$GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig;
|
|
8000
|
+
/**
|
|
8001
|
+
* Identity provider type configured.
|
|
8002
|
+
*/
|
|
8003
|
+
idpType?: string | null;
|
|
8004
|
+
}
|
|
8005
|
+
/**
|
|
8006
|
+
* Third party IDP Config.
|
|
8007
|
+
*/
|
|
8008
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig {
|
|
8009
|
+
/**
|
|
8010
|
+
* Workforce pool name. Example: "locations/global/workforcePools/pool_id"
|
|
8011
|
+
*/
|
|
8012
|
+
workforcePoolName?: string | null;
|
|
8013
|
+
}
|
|
7239
8014
|
/**
|
|
7240
8015
|
* Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
7241
8016
|
*/
|
|
@@ -7478,6 +8253,51 @@ export declare namespace discoveryengine_v1 {
|
|
|
7478
8253
|
*/
|
|
7479
8254
|
region?: string | null;
|
|
7480
8255
|
}
|
|
8256
|
+
/**
|
|
8257
|
+
* Information about users' licenses.
|
|
8258
|
+
*/
|
|
8259
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig {
|
|
8260
|
+
/**
|
|
8261
|
+
* Optional. The alert policy config for this license config.
|
|
8262
|
+
*/
|
|
8263
|
+
alertPolicyResourceConfig?: Schema$GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig;
|
|
8264
|
+
/**
|
|
8265
|
+
* Optional. Whether the license config should be auto renewed when it reaches the end date.
|
|
8266
|
+
*/
|
|
8267
|
+
autoRenew?: boolean | null;
|
|
8268
|
+
/**
|
|
8269
|
+
* Optional. The planed end date.
|
|
8270
|
+
*/
|
|
8271
|
+
endDate?: Schema$GoogleTypeDate;
|
|
8272
|
+
/**
|
|
8273
|
+
* Optional. Whether the license config is for free trial.
|
|
8274
|
+
*/
|
|
8275
|
+
freeTrial?: boolean | null;
|
|
8276
|
+
/**
|
|
8277
|
+
* Required. Number of licenses purchased.
|
|
8278
|
+
*/
|
|
8279
|
+
licenseCount?: string | null;
|
|
8280
|
+
/**
|
|
8281
|
+
* Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}`
|
|
8282
|
+
*/
|
|
8283
|
+
name?: string | null;
|
|
8284
|
+
/**
|
|
8285
|
+
* Required. The start date.
|
|
8286
|
+
*/
|
|
8287
|
+
startDate?: Schema$GoogleTypeDate;
|
|
8288
|
+
/**
|
|
8289
|
+
* Output only. The state of the license config.
|
|
8290
|
+
*/
|
|
8291
|
+
state?: string | null;
|
|
8292
|
+
/**
|
|
8293
|
+
* Required. Subscription term.
|
|
8294
|
+
*/
|
|
8295
|
+
subscriptionTerm?: string | null;
|
|
8296
|
+
/**
|
|
8297
|
+
* Required. Subscription tier information for the license config.
|
|
8298
|
+
*/
|
|
8299
|
+
subscriptionTier?: string | null;
|
|
8300
|
+
}
|
|
7481
8301
|
/**
|
|
7482
8302
|
* Configuration for Natural Language Query Understanding.
|
|
7483
8303
|
*/
|
|
@@ -7529,6 +8349,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
7529
8349
|
* Output only. The timestamp when this project is created.
|
|
7530
8350
|
*/
|
|
7531
8351
|
createTime?: string | null;
|
|
8352
|
+
/**
|
|
8353
|
+
* Optional. Customer provided configurations.
|
|
8354
|
+
*/
|
|
8355
|
+
customerProvidedConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig;
|
|
7532
8356
|
/**
|
|
7533
8357
|
* Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
|
|
7534
8358
|
*/
|
|
@@ -7544,6 +8368,37 @@ export declare namespace discoveryengine_v1 {
|
|
|
7544
8368
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms;
|
|
7545
8369
|
} | null;
|
|
7546
8370
|
}
|
|
8371
|
+
/**
|
|
8372
|
+
* Customer provided configurations.
|
|
8373
|
+
*/
|
|
8374
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig {
|
|
8375
|
+
/**
|
|
8376
|
+
* Optional. Configuration for NotebookLM settings.
|
|
8377
|
+
*/
|
|
8378
|
+
notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig;
|
|
8379
|
+
}
|
|
8380
|
+
/**
|
|
8381
|
+
* Configuration for NotebookLM.
|
|
8382
|
+
*/
|
|
8383
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig {
|
|
8384
|
+
/**
|
|
8385
|
+
* Model Armor configuration to be used for sanitizing user prompts and LLM responses.
|
|
8386
|
+
*/
|
|
8387
|
+
modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
|
|
8388
|
+
}
|
|
8389
|
+
/**
|
|
8390
|
+
* Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
|
|
8391
|
+
*/
|
|
8392
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig {
|
|
8393
|
+
/**
|
|
8394
|
+
* Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the LLM response.
|
|
8395
|
+
*/
|
|
8396
|
+
responseTemplate?: string | null;
|
|
8397
|
+
/**
|
|
8398
|
+
* Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the user prompt.
|
|
8399
|
+
*/
|
|
8400
|
+
userPromptTemplate?: string | null;
|
|
8401
|
+
}
|
|
7547
8402
|
/**
|
|
7548
8403
|
* Metadata about the terms of service.
|
|
7549
8404
|
*/
|
|
@@ -7807,11 +8662,11 @@ export declare namespace discoveryengine_v1 {
|
|
|
7807
8662
|
*/
|
|
7808
8663
|
languageCode?: string | null;
|
|
7809
8664
|
/**
|
|
7810
|
-
* Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
|
|
8665
|
+
* Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
|
|
7811
8666
|
*/
|
|
7812
8667
|
naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec;
|
|
7813
8668
|
/**
|
|
7814
|
-
* A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
|
|
8669
|
+
* A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
|
|
7815
8670
|
*/
|
|
7816
8671
|
offset?: number | null;
|
|
7817
8672
|
/**
|
|
@@ -7872,6 +8727,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
7872
8727
|
* Whether to turn on safe search. This is only supported for website search.
|
|
7873
8728
|
*/
|
|
7874
8729
|
safeSearch?: boolean | null;
|
|
8730
|
+
/**
|
|
8731
|
+
* Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests.
|
|
8732
|
+
*/
|
|
8733
|
+
searchAddonSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec;
|
|
7875
8734
|
/**
|
|
7876
8735
|
* Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
|
|
7877
8736
|
*/
|
|
@@ -8242,6 +9101,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
8242
9101
|
* Specification to enable natural language understanding capabilities for search requests.
|
|
8243
9102
|
*/
|
|
8244
9103
|
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec {
|
|
9104
|
+
/**
|
|
9105
|
+
* Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
|
|
9106
|
+
*/
|
|
9107
|
+
allowedFieldNames?: string[] | null;
|
|
8245
9108
|
/**
|
|
8246
9109
|
* Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
|
|
8247
9110
|
*/
|
|
@@ -8286,6 +9149,23 @@ export declare namespace discoveryengine_v1 {
|
|
|
8286
9149
|
*/
|
|
8287
9150
|
returnRelevanceScore?: boolean | null;
|
|
8288
9151
|
}
|
|
9152
|
+
/**
|
|
9153
|
+
* SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.
|
|
9154
|
+
*/
|
|
9155
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec {
|
|
9156
|
+
/**
|
|
9157
|
+
* Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
|
|
9158
|
+
*/
|
|
9159
|
+
disableGenerativeAnswerAddOn?: boolean | null;
|
|
9160
|
+
/**
|
|
9161
|
+
* Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
|
|
9162
|
+
*/
|
|
9163
|
+
disableKpiPersonalizationAddOn?: boolean | null;
|
|
9164
|
+
/**
|
|
9165
|
+
* Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
|
|
9166
|
+
*/
|
|
9167
|
+
disableSemanticAddOn?: boolean | null;
|
|
9168
|
+
}
|
|
8289
9169
|
/**
|
|
8290
9170
|
* Specification for search as you type in search requests.
|
|
8291
9171
|
*/
|
|
@@ -8990,6 +9870,23 @@ export declare namespace discoveryengine_v1 {
|
|
|
8990
9870
|
*/
|
|
8991
9871
|
state?: string | null;
|
|
8992
9872
|
}
|
|
9873
|
+
/**
|
|
9874
|
+
* Collection is a container for configuring resources and access to a set of DataStores.
|
|
9875
|
+
*/
|
|
9876
|
+
export interface Schema$GoogleCloudDiscoveryengineV1Collection {
|
|
9877
|
+
/**
|
|
9878
|
+
* Output only. Timestamp the Collection was created at.
|
|
9879
|
+
*/
|
|
9880
|
+
createTime?: string | null;
|
|
9881
|
+
/**
|
|
9882
|
+
* Required. The Collection display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
9883
|
+
*/
|
|
9884
|
+
displayName?: string | null;
|
|
9885
|
+
/**
|
|
9886
|
+
* Immutable. The full resource name of the Collection. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
9887
|
+
*/
|
|
9888
|
+
name?: string | null;
|
|
9889
|
+
}
|
|
8993
9890
|
/**
|
|
8994
9891
|
* Response message for CompletionService.CompleteQuery method.
|
|
8995
9892
|
*/
|
|
@@ -9105,6 +10002,15 @@ export declare namespace discoveryengine_v1 {
|
|
|
9105
10002
|
*/
|
|
9106
10003
|
startTime?: string | null;
|
|
9107
10004
|
}
|
|
10005
|
+
/**
|
|
10006
|
+
* The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
|
|
10007
|
+
*/
|
|
10008
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ContactDetails {
|
|
10009
|
+
/**
|
|
10010
|
+
* Optional. The email address of the contact.
|
|
10011
|
+
*/
|
|
10012
|
+
emailAddress?: string | null;
|
|
10013
|
+
}
|
|
9108
10014
|
/**
|
|
9109
10015
|
* Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.
|
|
9110
10016
|
*/
|
|
@@ -9502,6 +10408,282 @@ export declare namespace discoveryengine_v1 {
|
|
|
9502
10408
|
*/
|
|
9503
10409
|
trainingStartTime?: string | null;
|
|
9504
10410
|
}
|
|
10411
|
+
/**
|
|
10412
|
+
* Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.
|
|
10413
|
+
*/
|
|
10414
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataConnector {
|
|
10415
|
+
/**
|
|
10416
|
+
* Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.
|
|
10417
|
+
*/
|
|
10418
|
+
aclEnabled?: boolean | null;
|
|
10419
|
+
/**
|
|
10420
|
+
* Optional. Action configurations to make the connector support actions.
|
|
10421
|
+
*/
|
|
10422
|
+
actionConfig?: Schema$GoogleCloudDiscoveryengineV1ActionConfig;
|
|
10423
|
+
/**
|
|
10424
|
+
* Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.
|
|
10425
|
+
*/
|
|
10426
|
+
actionState?: string | null;
|
|
10427
|
+
/**
|
|
10428
|
+
* Optional. The connector level alert config.
|
|
10429
|
+
*/
|
|
10430
|
+
alertPolicyConfigs?: Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfig[];
|
|
10431
|
+
/**
|
|
10432
|
+
* Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs
|
|
10433
|
+
*/
|
|
10434
|
+
autoRunDisabled?: boolean | null;
|
|
10435
|
+
/**
|
|
10436
|
+
* Optional. The configuration for establishing a BAP connection.
|
|
10437
|
+
*/
|
|
10438
|
+
bapConfig?: Schema$GoogleCloudDiscoveryengineV1BAPConfig;
|
|
10439
|
+
/**
|
|
10440
|
+
* Output only. User actions that must be completed before the connector can start syncing data.
|
|
10441
|
+
*/
|
|
10442
|
+
blockingReasons?: string[] | null;
|
|
10443
|
+
/**
|
|
10444
|
+
* Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
|
|
10445
|
+
*/
|
|
10446
|
+
connectorModes?: string[] | null;
|
|
10447
|
+
/**
|
|
10448
|
+
* Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
|
|
10449
|
+
*/
|
|
10450
|
+
connectorType?: string | null;
|
|
10451
|
+
/**
|
|
10452
|
+
* Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
|
|
10453
|
+
*/
|
|
10454
|
+
createEuaSaas?: boolean | null;
|
|
10455
|
+
/**
|
|
10456
|
+
* Output only. Timestamp the DataConnector was created at.
|
|
10457
|
+
*/
|
|
10458
|
+
createTime?: string | null;
|
|
10459
|
+
/**
|
|
10460
|
+
* Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.
|
|
10461
|
+
*/
|
|
10462
|
+
dataSource?: string | null;
|
|
10463
|
+
/**
|
|
10464
|
+
* Optional. Any target destinations used to connect to third-party services.
|
|
10465
|
+
*/
|
|
10466
|
+
destinationConfigs?: Schema$GoogleCloudDiscoveryengineV1DestinationConfig[];
|
|
10467
|
+
/**
|
|
10468
|
+
* Optional. Any params and credentials used specifically for EUA connectors.
|
|
10469
|
+
*/
|
|
10470
|
+
endUserConfig?: Schema$GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig;
|
|
10471
|
+
/**
|
|
10472
|
+
* List of entities from the connected data source to ingest.
|
|
10473
|
+
*/
|
|
10474
|
+
entities?: Schema$GoogleCloudDiscoveryengineV1DataConnectorSourceEntity[];
|
|
10475
|
+
/**
|
|
10476
|
+
* Output only. The errors from initialization or from the latest connector run.
|
|
10477
|
+
*/
|
|
10478
|
+
errors?: Schema$GoogleRpcStatus[];
|
|
10479
|
+
/**
|
|
10480
|
+
* Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode.
|
|
10481
|
+
*/
|
|
10482
|
+
federatedConfig?: Schema$GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig;
|
|
10483
|
+
/**
|
|
10484
|
+
* Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.
|
|
10485
|
+
*/
|
|
10486
|
+
hybridIngestionDisabled?: boolean | null;
|
|
10487
|
+
/**
|
|
10488
|
+
* The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.
|
|
10489
|
+
*/
|
|
10490
|
+
identityRefreshInterval?: string | null;
|
|
10491
|
+
/**
|
|
10492
|
+
* The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector.
|
|
10493
|
+
*/
|
|
10494
|
+
identityScheduleConfig?: Schema$GoogleCloudDiscoveryengineV1IdentityScheduleConfig;
|
|
10495
|
+
/**
|
|
10496
|
+
* Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
|
|
10497
|
+
*/
|
|
10498
|
+
incrementalRefreshInterval?: string | null;
|
|
10499
|
+
/**
|
|
10500
|
+
* Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.
|
|
10501
|
+
*/
|
|
10502
|
+
incrementalSyncDisabled?: boolean | null;
|
|
10503
|
+
/**
|
|
10504
|
+
* Required data connector parameters in json string format.
|
|
10505
|
+
*/
|
|
10506
|
+
jsonParams?: string | null;
|
|
10507
|
+
/**
|
|
10508
|
+
* Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
|
|
10509
|
+
*/
|
|
10510
|
+
kmsKeyName?: string | null;
|
|
10511
|
+
/**
|
|
10512
|
+
* Output only. For periodic connectors only, the last time a data sync was completed.
|
|
10513
|
+
*/
|
|
10514
|
+
lastSyncTime?: string | null;
|
|
10515
|
+
/**
|
|
10516
|
+
* Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.
|
|
10517
|
+
*/
|
|
10518
|
+
latestPauseTime?: string | null;
|
|
10519
|
+
/**
|
|
10520
|
+
* Output only. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`.
|
|
10521
|
+
*/
|
|
10522
|
+
name?: string | null;
|
|
10523
|
+
/**
|
|
10524
|
+
* Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.
|
|
10525
|
+
*/
|
|
10526
|
+
nextSyncTime?: Schema$GoogleTypeDateTime;
|
|
10527
|
+
/**
|
|
10528
|
+
* Required data connector parameters in structured json format.
|
|
10529
|
+
*/
|
|
10530
|
+
params?: {
|
|
10531
|
+
[key: string]: any;
|
|
10532
|
+
} | null;
|
|
10533
|
+
/**
|
|
10534
|
+
* Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.
|
|
10535
|
+
*/
|
|
10536
|
+
privateConnectivityProjectId?: string | null;
|
|
10537
|
+
/**
|
|
10538
|
+
* Output only. real-time sync state
|
|
10539
|
+
*/
|
|
10540
|
+
realtimeState?: string | null;
|
|
10541
|
+
/**
|
|
10542
|
+
* Optional. The configuration for realtime sync.
|
|
10543
|
+
*/
|
|
10544
|
+
realtimeSyncConfig?: Schema$GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig;
|
|
10545
|
+
/**
|
|
10546
|
+
* Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
|
|
10547
|
+
*/
|
|
10548
|
+
refreshInterval?: string | null;
|
|
10549
|
+
/**
|
|
10550
|
+
* Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.
|
|
10551
|
+
*/
|
|
10552
|
+
removeParamKeys?: string[] | null;
|
|
10553
|
+
/**
|
|
10554
|
+
* Output only. State of the connector.
|
|
10555
|
+
*/
|
|
10556
|
+
state?: string | null;
|
|
10557
|
+
/**
|
|
10558
|
+
* Output only. The static IP addresses used by this connector.
|
|
10559
|
+
*/
|
|
10560
|
+
staticIpAddresses?: string[] | null;
|
|
10561
|
+
/**
|
|
10562
|
+
* Optional. Whether customer has enabled static IP addresses for this connector.
|
|
10563
|
+
*/
|
|
10564
|
+
staticIpEnabled?: boolean | null;
|
|
10565
|
+
/**
|
|
10566
|
+
* The data synchronization mode supported by the data connector.
|
|
10567
|
+
*/
|
|
10568
|
+
syncMode?: string | null;
|
|
10569
|
+
/**
|
|
10570
|
+
* Output only. Timestamp the DataConnector was last updated.
|
|
10571
|
+
*/
|
|
10572
|
+
updateTime?: string | null;
|
|
10573
|
+
}
|
|
10574
|
+
/**
|
|
10575
|
+
* Any params and credentials used specifically for EUA connectors.
|
|
10576
|
+
*/
|
|
10577
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig {
|
|
10578
|
+
/**
|
|
10579
|
+
* Optional. Any additional parameters needed for EUA.
|
|
10580
|
+
*/
|
|
10581
|
+
additionalParams?: {
|
|
10582
|
+
[key: string]: any;
|
|
10583
|
+
} | null;
|
|
10584
|
+
/**
|
|
10585
|
+
* Optional. Any authentication parameters specific to EUA connectors.
|
|
10586
|
+
*/
|
|
10587
|
+
authParams?: {
|
|
10588
|
+
[key: string]: any;
|
|
10589
|
+
} | null;
|
|
10590
|
+
/**
|
|
10591
|
+
* Optional. Any authentication parameters specific to EUA connectors in json string format.
|
|
10592
|
+
*/
|
|
10593
|
+
jsonAuthParams?: string | null;
|
|
10594
|
+
/**
|
|
10595
|
+
* Optional. The tenant project the connector is connected to.
|
|
10596
|
+
*/
|
|
10597
|
+
tenant?: Schema$GoogleCloudDiscoveryengineV1Tenant;
|
|
10598
|
+
}
|
|
10599
|
+
/**
|
|
10600
|
+
* Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.
|
|
10601
|
+
*/
|
|
10602
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig {
|
|
10603
|
+
/**
|
|
10604
|
+
* Optional. Any additional parameters needed for FEDERATED.
|
|
10605
|
+
*/
|
|
10606
|
+
additionalParams?: {
|
|
10607
|
+
[key: string]: any;
|
|
10608
|
+
} | null;
|
|
10609
|
+
/**
|
|
10610
|
+
* Optional. Any authentication parameters specific to FEDERATED connectors.
|
|
10611
|
+
*/
|
|
10612
|
+
authParams?: {
|
|
10613
|
+
[key: string]: any;
|
|
10614
|
+
} | null;
|
|
10615
|
+
/**
|
|
10616
|
+
* Optional. Any authentication parameters specific to FEDERATED connectors in json string format.
|
|
10617
|
+
*/
|
|
10618
|
+
jsonAuthParams?: string | null;
|
|
10619
|
+
}
|
|
10620
|
+
/**
|
|
10621
|
+
* The configuration for realtime sync to store additional params for realtime sync.
|
|
10622
|
+
*/
|
|
10623
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig {
|
|
10624
|
+
/**
|
|
10625
|
+
* Optional. The ID of the Secret Manager secret used for webhook secret.
|
|
10626
|
+
*/
|
|
10627
|
+
realtimeSyncSecret?: string | null;
|
|
10628
|
+
/**
|
|
10629
|
+
* Optional. Streaming error details.
|
|
10630
|
+
*/
|
|
10631
|
+
streamingError?: Schema$GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError;
|
|
10632
|
+
/**
|
|
10633
|
+
* Optional. Webhook url for the connector to specify additional params for realtime sync.
|
|
10634
|
+
*/
|
|
10635
|
+
webhookUri?: string | null;
|
|
10636
|
+
}
|
|
10637
|
+
/**
|
|
10638
|
+
* Streaming error details.
|
|
10639
|
+
*/
|
|
10640
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError {
|
|
10641
|
+
/**
|
|
10642
|
+
* Optional. Error details.
|
|
10643
|
+
*/
|
|
10644
|
+
error?: Schema$GoogleRpcStatus;
|
|
10645
|
+
/**
|
|
10646
|
+
* Optional. Streaming error.
|
|
10647
|
+
*/
|
|
10648
|
+
streamingErrorReason?: string | null;
|
|
10649
|
+
}
|
|
10650
|
+
/**
|
|
10651
|
+
* Represents an entity in the data source. For example, the `Account` object in Salesforce.
|
|
10652
|
+
*/
|
|
10653
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorSourceEntity {
|
|
10654
|
+
/**
|
|
10655
|
+
* Output only. The full resource name of the associated data store for the source entity. Format: `projects/x/locations/x/collections/x/dataStores/x`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.
|
|
10656
|
+
*/
|
|
10657
|
+
dataStore?: string | null;
|
|
10658
|
+
/**
|
|
10659
|
+
* The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`
|
|
10660
|
+
*/
|
|
10661
|
+
entityName?: string | null;
|
|
10662
|
+
/**
|
|
10663
|
+
* Optional. Configuration for `HEALTHCARE_FHIR` vertical.
|
|
10664
|
+
*/
|
|
10665
|
+
healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1HealthcareFhirConfig;
|
|
10666
|
+
/**
|
|
10667
|
+
* The parameters for the entity to facilitate data ingestion in json string format.
|
|
10668
|
+
*/
|
|
10669
|
+
jsonParams?: string | null;
|
|
10670
|
+
/**
|
|
10671
|
+
* Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.
|
|
10672
|
+
*/
|
|
10673
|
+
keyPropertyMappings?: {
|
|
10674
|
+
[key: string]: string;
|
|
10675
|
+
} | null;
|
|
10676
|
+
/**
|
|
10677
|
+
* The parameters for the entity to facilitate data ingestion in structured json format.
|
|
10678
|
+
*/
|
|
10679
|
+
params?: {
|
|
10680
|
+
[key: string]: any;
|
|
10681
|
+
} | null;
|
|
10682
|
+
/**
|
|
10683
|
+
* Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
|
|
10684
|
+
*/
|
|
10685
|
+
startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema;
|
|
10686
|
+
}
|
|
9505
10687
|
/**
|
|
9506
10688
|
* DataStore captures global settings and configs at the DataStore level.
|
|
9507
10689
|
*/
|
|
@@ -9522,6 +10704,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
9522
10704
|
* Output only. CMEK-related information for the DataStore.
|
|
9523
10705
|
*/
|
|
9524
10706
|
cmekConfig?: Schema$GoogleCloudDiscoveryengineV1CmekConfig;
|
|
10707
|
+
/**
|
|
10708
|
+
* Optional. Configuration for configurable billing approach. See
|
|
10709
|
+
*/
|
|
10710
|
+
configurableBillingApproach?: string | null;
|
|
9525
10711
|
/**
|
|
9526
10712
|
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
9527
10713
|
*/
|
|
@@ -9634,6 +10820,19 @@ export declare namespace discoveryengine_v1 {
|
|
|
9634
10820
|
*/
|
|
9635
10821
|
updateTime?: string | null;
|
|
9636
10822
|
}
|
|
10823
|
+
/**
|
|
10824
|
+
* Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
10825
|
+
*/
|
|
10826
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteCollectionMetadata {
|
|
10827
|
+
/**
|
|
10828
|
+
* Operation create time.
|
|
10829
|
+
*/
|
|
10830
|
+
createTime?: string | null;
|
|
10831
|
+
/**
|
|
10832
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
10833
|
+
*/
|
|
10834
|
+
updateTime?: string | null;
|
|
10835
|
+
}
|
|
9637
10836
|
/**
|
|
9638
10837
|
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
9639
10838
|
*/
|
|
@@ -9712,6 +10911,42 @@ export declare namespace discoveryengine_v1 {
|
|
|
9712
10911
|
*/
|
|
9713
10912
|
updateTime?: string | null;
|
|
9714
10913
|
}
|
|
10914
|
+
/**
|
|
10915
|
+
* Defines target endpoints used to connect to third-party sources.
|
|
10916
|
+
*/
|
|
10917
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DestinationConfig {
|
|
10918
|
+
/**
|
|
10919
|
+
* Optional. The destinations for the corresponding key.
|
|
10920
|
+
*/
|
|
10921
|
+
destinations?: Schema$GoogleCloudDiscoveryengineV1DestinationConfigDestination[];
|
|
10922
|
+
/**
|
|
10923
|
+
* Additional parameters for this destination config in json string format.
|
|
10924
|
+
*/
|
|
10925
|
+
jsonParams?: string | null;
|
|
10926
|
+
/**
|
|
10927
|
+
* Optional. Unique destination identifier that is supported by the connector.
|
|
10928
|
+
*/
|
|
10929
|
+
key?: string | null;
|
|
10930
|
+
/**
|
|
10931
|
+
* Optional. Additional parameters for this destination config in structured json format.
|
|
10932
|
+
*/
|
|
10933
|
+
params?: {
|
|
10934
|
+
[key: string]: any;
|
|
10935
|
+
} | null;
|
|
10936
|
+
}
|
|
10937
|
+
/**
|
|
10938
|
+
* Defines a target endpoint
|
|
10939
|
+
*/
|
|
10940
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DestinationConfigDestination {
|
|
10941
|
+
/**
|
|
10942
|
+
* Publicly routable host.
|
|
10943
|
+
*/
|
|
10944
|
+
host?: string | null;
|
|
10945
|
+
/**
|
|
10946
|
+
* Optional. Target port number accepted by the destination.
|
|
10947
|
+
*/
|
|
10948
|
+
port?: number | null;
|
|
10949
|
+
}
|
|
9715
10950
|
/**
|
|
9716
10951
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
9717
10952
|
*/
|
|
@@ -10026,6 +11261,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
10026
11261
|
* Metadata that describes the training and serving parameters of an Engine.
|
|
10027
11262
|
*/
|
|
10028
11263
|
export interface Schema$GoogleCloudDiscoveryengineV1Engine {
|
|
11264
|
+
/**
|
|
11265
|
+
* Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.
|
|
11266
|
+
*/
|
|
11267
|
+
appType?: string | null;
|
|
10029
11268
|
/**
|
|
10030
11269
|
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
10031
11270
|
*/
|
|
@@ -10038,6 +11277,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
10038
11277
|
* Common config spec that specifies the metadata of the engine.
|
|
10039
11278
|
*/
|
|
10040
11279
|
commonConfig?: Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig;
|
|
11280
|
+
/**
|
|
11281
|
+
* Optional. Configuration for configurable billing approach.
|
|
11282
|
+
*/
|
|
11283
|
+
configurableBillingApproach?: string | null;
|
|
10041
11284
|
/**
|
|
10042
11285
|
* Output only. Timestamp the Recommendation Engine was created at.
|
|
10043
11286
|
*/
|
|
@@ -10055,7 +11298,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
10055
11298
|
*/
|
|
10056
11299
|
displayName?: string | null;
|
|
10057
11300
|
/**
|
|
10058
|
-
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` -
|
|
11301
|
+
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
|
|
10059
11302
|
*/
|
|
10060
11303
|
features?: {
|
|
10061
11304
|
[key: string]: string;
|
|
@@ -10427,6 +11670,41 @@ export declare namespace discoveryengine_v1 {
|
|
|
10427
11670
|
*/
|
|
10428
11671
|
name?: string | null;
|
|
10429
11672
|
}
|
|
11673
|
+
/**
|
|
11674
|
+
* The configuration for the identity data synchronization runs.
|
|
11675
|
+
*/
|
|
11676
|
+
export interface Schema$GoogleCloudDiscoveryengineV1IdentityScheduleConfig {
|
|
11677
|
+
/**
|
|
11678
|
+
* Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day.
|
|
11679
|
+
*/
|
|
11680
|
+
nextSyncTime?: Schema$GoogleTypeDateTime;
|
|
11681
|
+
/**
|
|
11682
|
+
* Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.
|
|
11683
|
+
*/
|
|
11684
|
+
refreshInterval?: string | null;
|
|
11685
|
+
}
|
|
11686
|
+
/**
|
|
11687
|
+
* Identity Provider Config.
|
|
11688
|
+
*/
|
|
11689
|
+
export interface Schema$GoogleCloudDiscoveryengineV1IdpConfig {
|
|
11690
|
+
/**
|
|
11691
|
+
* External Identity provider config.
|
|
11692
|
+
*/
|
|
11693
|
+
externalIdpConfig?: Schema$GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig;
|
|
11694
|
+
/**
|
|
11695
|
+
* Identity provider type configured.
|
|
11696
|
+
*/
|
|
11697
|
+
idpType?: string | null;
|
|
11698
|
+
}
|
|
11699
|
+
/**
|
|
11700
|
+
* Third party IDP Config.
|
|
11701
|
+
*/
|
|
11702
|
+
export interface Schema$GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig {
|
|
11703
|
+
/**
|
|
11704
|
+
* Workforce pool name. Example: "locations/global/workforcePools/pool_id"
|
|
11705
|
+
*/
|
|
11706
|
+
workforcePoolName?: string | null;
|
|
11707
|
+
}
|
|
10430
11708
|
/**
|
|
10431
11709
|
* Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
10432
11710
|
*/
|
|
@@ -10784,6 +12062,51 @@ export declare namespace discoveryengine_v1 {
|
|
|
10784
12062
|
*/
|
|
10785
12063
|
minimum?: number | null;
|
|
10786
12064
|
}
|
|
12065
|
+
/**
|
|
12066
|
+
* Information about users' licenses.
|
|
12067
|
+
*/
|
|
12068
|
+
export interface Schema$GoogleCloudDiscoveryengineV1LicenseConfig {
|
|
12069
|
+
/**
|
|
12070
|
+
* Optional. The alert policy config for this license config.
|
|
12071
|
+
*/
|
|
12072
|
+
alertPolicyResourceConfig?: Schema$GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig;
|
|
12073
|
+
/**
|
|
12074
|
+
* Optional. Whether the license config should be auto renewed when it reaches the end date.
|
|
12075
|
+
*/
|
|
12076
|
+
autoRenew?: boolean | null;
|
|
12077
|
+
/**
|
|
12078
|
+
* Optional. The planed end date.
|
|
12079
|
+
*/
|
|
12080
|
+
endDate?: Schema$GoogleTypeDate;
|
|
12081
|
+
/**
|
|
12082
|
+
* Optional. Whether the license config is for free trial.
|
|
12083
|
+
*/
|
|
12084
|
+
freeTrial?: boolean | null;
|
|
12085
|
+
/**
|
|
12086
|
+
* Required. Number of licenses purchased.
|
|
12087
|
+
*/
|
|
12088
|
+
licenseCount?: string | null;
|
|
12089
|
+
/**
|
|
12090
|
+
* Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}`
|
|
12091
|
+
*/
|
|
12092
|
+
name?: string | null;
|
|
12093
|
+
/**
|
|
12094
|
+
* Required. The start date.
|
|
12095
|
+
*/
|
|
12096
|
+
startDate?: Schema$GoogleTypeDate;
|
|
12097
|
+
/**
|
|
12098
|
+
* Output only. The state of the license config.
|
|
12099
|
+
*/
|
|
12100
|
+
state?: string | null;
|
|
12101
|
+
/**
|
|
12102
|
+
* Required. Subscription term.
|
|
12103
|
+
*/
|
|
12104
|
+
subscriptionTerm?: string | null;
|
|
12105
|
+
/**
|
|
12106
|
+
* Required. Subscription tier information for the license config.
|
|
12107
|
+
*/
|
|
12108
|
+
subscriptionTier?: string | null;
|
|
12109
|
+
}
|
|
10787
12110
|
/**
|
|
10788
12111
|
* Response message for CmekConfigService.ListCmekConfigs method.
|
|
10789
12112
|
*/
|
|
@@ -11033,6 +12356,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
11033
12356
|
* Output only. The timestamp when this project is created.
|
|
11034
12357
|
*/
|
|
11035
12358
|
createTime?: string | null;
|
|
12359
|
+
/**
|
|
12360
|
+
* Optional. Customer provided configurations.
|
|
12361
|
+
*/
|
|
12362
|
+
customerProvidedConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig;
|
|
11036
12363
|
/**
|
|
11037
12364
|
* Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
|
|
11038
12365
|
*/
|
|
@@ -11048,6 +12375,37 @@ export declare namespace discoveryengine_v1 {
|
|
|
11048
12375
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms;
|
|
11049
12376
|
} | null;
|
|
11050
12377
|
}
|
|
12378
|
+
/**
|
|
12379
|
+
* Customer provided configurations.
|
|
12380
|
+
*/
|
|
12381
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig {
|
|
12382
|
+
/**
|
|
12383
|
+
* Optional. Configuration for NotebookLM settings.
|
|
12384
|
+
*/
|
|
12385
|
+
notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig;
|
|
12386
|
+
}
|
|
12387
|
+
/**
|
|
12388
|
+
* Configuration for NotebookLM.
|
|
12389
|
+
*/
|
|
12390
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig {
|
|
12391
|
+
/**
|
|
12392
|
+
* Model Armor configuration to be used for sanitizing user prompts and LLM responses.
|
|
12393
|
+
*/
|
|
12394
|
+
modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
|
|
12395
|
+
}
|
|
12396
|
+
/**
|
|
12397
|
+
* Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
|
|
12398
|
+
*/
|
|
12399
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig {
|
|
12400
|
+
/**
|
|
12401
|
+
* Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the LLM response.
|
|
12402
|
+
*/
|
|
12403
|
+
responseTemplate?: string | null;
|
|
12404
|
+
/**
|
|
12405
|
+
* Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the user prompt.
|
|
12406
|
+
*/
|
|
12407
|
+
userPromptTemplate?: string | null;
|
|
12408
|
+
}
|
|
11051
12409
|
/**
|
|
11052
12410
|
* Metadata about the terms of service.
|
|
11053
12411
|
*/
|
|
@@ -11103,6 +12461,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
11103
12461
|
* Optional. Set to `true` to specify that caller has read and would like to give consent to the [Terms for Agent Space quality of service].
|
|
11104
12462
|
*/
|
|
11105
12463
|
acceptBizQos?: boolean | null;
|
|
12464
|
+
/**
|
|
12465
|
+
* Optional. Indicates if the current request is for Biz edition (= true) or not (= false).
|
|
12466
|
+
*/
|
|
12467
|
+
isBiz?: boolean | null;
|
|
11106
12468
|
}
|
|
11107
12469
|
/**
|
|
11108
12470
|
* Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
@@ -11594,7 +12956,11 @@ export declare namespace discoveryengine_v1 {
|
|
|
11594
12956
|
*/
|
|
11595
12957
|
languageCode?: string | null;
|
|
11596
12958
|
/**
|
|
11597
|
-
*
|
|
12959
|
+
* Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
|
|
12960
|
+
*/
|
|
12961
|
+
naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec;
|
|
12962
|
+
/**
|
|
12963
|
+
* A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
|
|
11598
12964
|
*/
|
|
11599
12965
|
offset?: number | null;
|
|
11600
12966
|
/**
|
|
@@ -11974,6 +13340,27 @@ export declare namespace discoveryengine_v1 {
|
|
|
11974
13340
|
*/
|
|
11975
13341
|
imageBytes?: string | null;
|
|
11976
13342
|
}
|
|
13343
|
+
/**
|
|
13344
|
+
* Specification to enable natural language understanding capabilities for search requests.
|
|
13345
|
+
*/
|
|
13346
|
+
export interface Schema$GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec {
|
|
13347
|
+
/**
|
|
13348
|
+
* Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
|
|
13349
|
+
*/
|
|
13350
|
+
allowedFieldNames?: string[] | null;
|
|
13351
|
+
/**
|
|
13352
|
+
* Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
|
|
13353
|
+
*/
|
|
13354
|
+
extractedFilterBehavior?: string | null;
|
|
13355
|
+
/**
|
|
13356
|
+
* The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
|
|
13357
|
+
*/
|
|
13358
|
+
filterExtractionCondition?: string | null;
|
|
13359
|
+
/**
|
|
13360
|
+
* Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
|
|
13361
|
+
*/
|
|
13362
|
+
geoSearchQueryDetectionFieldNames?: string[] | null;
|
|
13363
|
+
}
|
|
11977
13364
|
/**
|
|
11978
13365
|
* Specification to determine under which conditions query expansion should occur.
|
|
11979
13366
|
*/
|
|
@@ -12505,6 +13892,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
12505
13892
|
* Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.
|
|
12506
13893
|
*/
|
|
12507
13894
|
detailedAnswer?: Schema$GoogleCloudDiscoveryengineV1Answer;
|
|
13895
|
+
/**
|
|
13896
|
+
* Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session.
|
|
13897
|
+
*/
|
|
13898
|
+
detailedAssistAnswer?: Schema$GoogleCloudDiscoveryengineV1AssistAnswer;
|
|
12508
13899
|
/**
|
|
12509
13900
|
* Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
|
|
12510
13901
|
*/
|
|
@@ -12516,6 +13907,28 @@ export declare namespace discoveryengine_v1 {
|
|
|
12516
13907
|
[key: string]: string;
|
|
12517
13908
|
} | null;
|
|
12518
13909
|
}
|
|
13910
|
+
/**
|
|
13911
|
+
* Metadata for DataConnectorService.SetUpDataConnector method.
|
|
13912
|
+
*/
|
|
13913
|
+
export interface Schema$GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata {
|
|
13914
|
+
}
|
|
13915
|
+
/**
|
|
13916
|
+
* Request for DataConnectorService.SetUpDataConnector method.
|
|
13917
|
+
*/
|
|
13918
|
+
export interface Schema$GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest {
|
|
13919
|
+
/**
|
|
13920
|
+
* Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
|
|
13921
|
+
*/
|
|
13922
|
+
collectionDisplayName?: string | null;
|
|
13923
|
+
/**
|
|
13924
|
+
* Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
13925
|
+
*/
|
|
13926
|
+
collectionId?: string | null;
|
|
13927
|
+
/**
|
|
13928
|
+
* Required. The DataConnector to initialize in the newly created Collection.
|
|
13929
|
+
*/
|
|
13930
|
+
dataConnector?: Schema$GoogleCloudDiscoveryengineV1DataConnector;
|
|
13931
|
+
}
|
|
12519
13932
|
/**
|
|
12520
13933
|
* Metadata for single-regional CMEKs.
|
|
12521
13934
|
*/
|
|
@@ -12774,6 +14187,23 @@ export declare namespace discoveryengine_v1 {
|
|
|
12774
14187
|
*/
|
|
12775
14188
|
totalRequiredQuota?: string | null;
|
|
12776
14189
|
}
|
|
14190
|
+
/**
|
|
14191
|
+
* Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user.
|
|
14192
|
+
*/
|
|
14193
|
+
export interface Schema$GoogleCloudDiscoveryengineV1Tenant {
|
|
14194
|
+
/**
|
|
14195
|
+
* Optional display name for the tenant, e.g. "My Slack Team".
|
|
14196
|
+
*/
|
|
14197
|
+
displayName?: string | null;
|
|
14198
|
+
/**
|
|
14199
|
+
* The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456").
|
|
14200
|
+
*/
|
|
14201
|
+
id?: string | null;
|
|
14202
|
+
/**
|
|
14203
|
+
* The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI.
|
|
14204
|
+
*/
|
|
14205
|
+
uri?: string | null;
|
|
14206
|
+
}
|
|
12777
14207
|
/**
|
|
12778
14208
|
* Defines text input.
|
|
12779
14209
|
*/
|
|
@@ -12980,7 +14410,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
12980
14410
|
*/
|
|
12981
14411
|
eventTime?: string | null;
|
|
12982
14412
|
/**
|
|
12983
|
-
* Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home \> Men \> Jeans
|
|
14413
|
+
* Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home \> Men \> Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.
|
|
12984
14414
|
*/
|
|
12985
14415
|
eventType?: string | null;
|
|
12986
14416
|
/**
|
|
@@ -13120,6 +14550,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
13120
14550
|
* A list of operations that matches the specified filter in the request.
|
|
13121
14551
|
*/
|
|
13122
14552
|
operations?: Schema$GoogleLongrunningOperation[];
|
|
14553
|
+
/**
|
|
14554
|
+
* Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
|
|
14555
|
+
*/
|
|
14556
|
+
unreachable?: string[] | null;
|
|
13123
14557
|
}
|
|
13124
14558
|
/**
|
|
13125
14559
|
* This resource represents a long-running operation that is the result of a network API call.
|
|
@@ -13541,12 +14975,74 @@ export declare namespace discoveryengine_v1 {
|
|
|
13541
14975
|
dataStores: Resource$Projects$Locations$Datastores;
|
|
13542
14976
|
groundingConfigs: Resource$Projects$Locations$Groundingconfigs;
|
|
13543
14977
|
identityMappingStores: Resource$Projects$Locations$Identitymappingstores;
|
|
14978
|
+
licenseConfigs: Resource$Projects$Locations$Licenseconfigs;
|
|
13544
14979
|
operations: Resource$Projects$Locations$Operations;
|
|
13545
14980
|
podcasts: Resource$Projects$Locations$Podcasts;
|
|
13546
14981
|
rankingConfigs: Resource$Projects$Locations$Rankingconfigs;
|
|
13547
14982
|
userEvents: Resource$Projects$Locations$Userevents;
|
|
13548
14983
|
userStores: Resource$Projects$Locations$Userstores;
|
|
13549
14984
|
constructor(context: APIRequestContext);
|
|
14985
|
+
/**
|
|
14986
|
+
* Gets the AclConfig.
|
|
14987
|
+
* @example
|
|
14988
|
+
* ```js
|
|
14989
|
+
* // Before running the sample:
|
|
14990
|
+
* // - Enable the API at:
|
|
14991
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
14992
|
+
* // - Login into gcloud by running:
|
|
14993
|
+
* // ```sh
|
|
14994
|
+
* // $ gcloud auth application-default login
|
|
14995
|
+
* // ```
|
|
14996
|
+
* // - Install the npm module by running:
|
|
14997
|
+
* // ```sh
|
|
14998
|
+
* // $ npm install googleapis
|
|
14999
|
+
* // ```
|
|
15000
|
+
*
|
|
15001
|
+
* const {google} = require('googleapis');
|
|
15002
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
15003
|
+
*
|
|
15004
|
+
* async function main() {
|
|
15005
|
+
* const auth = new google.auth.GoogleAuth({
|
|
15006
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
15007
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
15008
|
+
* });
|
|
15009
|
+
*
|
|
15010
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
15011
|
+
* const authClient = await auth.getClient();
|
|
15012
|
+
* google.options({auth: authClient});
|
|
15013
|
+
*
|
|
15014
|
+
* // Do the magic
|
|
15015
|
+
* const res = await discoveryengine.projects.locations.getAclConfig({
|
|
15016
|
+
* // Required. Resource name of AclConfig, such as `projects/x/locations/x/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
15017
|
+
* name: 'projects/my-project/locations/my-location/aclConfig',
|
|
15018
|
+
* });
|
|
15019
|
+
* console.log(res.data);
|
|
15020
|
+
*
|
|
15021
|
+
* // Example response
|
|
15022
|
+
* // {
|
|
15023
|
+
* // "idpConfig": {},
|
|
15024
|
+
* // "name": "my_name"
|
|
15025
|
+
* // }
|
|
15026
|
+
* }
|
|
15027
|
+
*
|
|
15028
|
+
* main().catch(e => {
|
|
15029
|
+
* console.error(e);
|
|
15030
|
+
* throw e;
|
|
15031
|
+
* });
|
|
15032
|
+
*
|
|
15033
|
+
* ```
|
|
15034
|
+
*
|
|
15035
|
+
* @param params - Parameters for request
|
|
15036
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
15037
|
+
* @param callback - Optional callback that handles the response.
|
|
15038
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
15039
|
+
*/
|
|
15040
|
+
getAclConfig(params: Params$Resource$Projects$Locations$Getaclconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
15041
|
+
getAclConfig(params?: Params$Resource$Projects$Locations$Getaclconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1AclConfig>>;
|
|
15042
|
+
getAclConfig(params: Params$Resource$Projects$Locations$Getaclconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
15043
|
+
getAclConfig(params: Params$Resource$Projects$Locations$Getaclconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AclConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AclConfig>): void;
|
|
15044
|
+
getAclConfig(params: Params$Resource$Projects$Locations$Getaclconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AclConfig>): void;
|
|
15045
|
+
getAclConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AclConfig>): void;
|
|
13550
15046
|
/**
|
|
13551
15047
|
* Gets the CmekConfig.
|
|
13552
15048
|
* @example
|
|
@@ -13577,22 +15073,620 @@ export declare namespace discoveryengine_v1 {
|
|
|
13577
15073
|
* google.options({auth: authClient});
|
|
13578
15074
|
*
|
|
13579
15075
|
* // Do the magic
|
|
13580
|
-
* const res = await discoveryengine.projects.locations.getCmekConfig({
|
|
13581
|
-
* // Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
13582
|
-
* name: 'projects/my-project/locations/my-location/cmekConfig',
|
|
15076
|
+
* const res = await discoveryengine.projects.locations.getCmekConfig({
|
|
15077
|
+
* // Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
15078
|
+
* name: 'projects/my-project/locations/my-location/cmekConfig',
|
|
15079
|
+
* });
|
|
15080
|
+
* console.log(res.data);
|
|
15081
|
+
*
|
|
15082
|
+
* // Example response
|
|
15083
|
+
* // {
|
|
15084
|
+
* // "isDefault": false,
|
|
15085
|
+
* // "kmsKey": "my_kmsKey",
|
|
15086
|
+
* // "kmsKeyVersion": "my_kmsKeyVersion",
|
|
15087
|
+
* // "lastRotationTimestampMicros": "my_lastRotationTimestampMicros",
|
|
15088
|
+
* // "name": "my_name",
|
|
15089
|
+
* // "notebooklmState": "my_notebooklmState",
|
|
15090
|
+
* // "singleRegionKeys": [],
|
|
15091
|
+
* // "state": "my_state"
|
|
15092
|
+
* // }
|
|
15093
|
+
* }
|
|
15094
|
+
*
|
|
15095
|
+
* main().catch(e => {
|
|
15096
|
+
* console.error(e);
|
|
15097
|
+
* throw e;
|
|
15098
|
+
* });
|
|
15099
|
+
*
|
|
15100
|
+
* ```
|
|
15101
|
+
*
|
|
15102
|
+
* @param params - Parameters for request
|
|
15103
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
15104
|
+
* @param callback - Optional callback that handles the response.
|
|
15105
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
15106
|
+
*/
|
|
15107
|
+
getCmekConfig(params: Params$Resource$Projects$Locations$Getcmekconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
15108
|
+
getCmekConfig(params?: Params$Resource$Projects$Locations$Getcmekconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1CmekConfig>>;
|
|
15109
|
+
getCmekConfig(params: Params$Resource$Projects$Locations$Getcmekconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
15110
|
+
getCmekConfig(params: Params$Resource$Projects$Locations$Getcmekconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1CmekConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1CmekConfig>): void;
|
|
15111
|
+
getCmekConfig(params: Params$Resource$Projects$Locations$Getcmekconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1CmekConfig>): void;
|
|
15112
|
+
getCmekConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1CmekConfig>): void;
|
|
15113
|
+
/**
|
|
15114
|
+
* Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.
|
|
15115
|
+
* @example
|
|
15116
|
+
* ```js
|
|
15117
|
+
* // Before running the sample:
|
|
15118
|
+
* // - Enable the API at:
|
|
15119
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
15120
|
+
* // - Login into gcloud by running:
|
|
15121
|
+
* // ```sh
|
|
15122
|
+
* // $ gcloud auth application-default login
|
|
15123
|
+
* // ```
|
|
15124
|
+
* // - Install the npm module by running:
|
|
15125
|
+
* // ```sh
|
|
15126
|
+
* // $ npm install googleapis
|
|
15127
|
+
* // ```
|
|
15128
|
+
*
|
|
15129
|
+
* const {google} = require('googleapis');
|
|
15130
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
15131
|
+
*
|
|
15132
|
+
* async function main() {
|
|
15133
|
+
* const auth = new google.auth.GoogleAuth({
|
|
15134
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
15135
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
15136
|
+
* });
|
|
15137
|
+
*
|
|
15138
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
15139
|
+
* const authClient = await auth.getClient();
|
|
15140
|
+
* google.options({auth: authClient});
|
|
15141
|
+
*
|
|
15142
|
+
* // Do the magic
|
|
15143
|
+
* const res = await discoveryengine.projects.locations.setUpDataConnector({
|
|
15144
|
+
* // Required. The parent of Collection, in the format of `projects/{project\}/locations/{location\}`.
|
|
15145
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
15146
|
+
*
|
|
15147
|
+
* // Request body metadata
|
|
15148
|
+
* requestBody: {
|
|
15149
|
+
* // request body parameters
|
|
15150
|
+
* // {
|
|
15151
|
+
* // "collectionDisplayName": "my_collectionDisplayName",
|
|
15152
|
+
* // "collectionId": "my_collectionId",
|
|
15153
|
+
* // "dataConnector": {}
|
|
15154
|
+
* // }
|
|
15155
|
+
* },
|
|
15156
|
+
* });
|
|
15157
|
+
* console.log(res.data);
|
|
15158
|
+
*
|
|
15159
|
+
* // Example response
|
|
15160
|
+
* // {
|
|
15161
|
+
* // "done": false,
|
|
15162
|
+
* // "error": {},
|
|
15163
|
+
* // "metadata": {},
|
|
15164
|
+
* // "name": "my_name",
|
|
15165
|
+
* // "response": {}
|
|
15166
|
+
* // }
|
|
15167
|
+
* }
|
|
15168
|
+
*
|
|
15169
|
+
* main().catch(e => {
|
|
15170
|
+
* console.error(e);
|
|
15171
|
+
* throw e;
|
|
15172
|
+
* });
|
|
15173
|
+
*
|
|
15174
|
+
* ```
|
|
15175
|
+
*
|
|
15176
|
+
* @param params - Parameters for request
|
|
15177
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
15178
|
+
* @param callback - Optional callback that handles the response.
|
|
15179
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
15180
|
+
*/
|
|
15181
|
+
setUpDataConnector(params: Params$Resource$Projects$Locations$Setupdataconnector, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
15182
|
+
setUpDataConnector(params?: Params$Resource$Projects$Locations$Setupdataconnector, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
15183
|
+
setUpDataConnector(params: Params$Resource$Projects$Locations$Setupdataconnector, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
15184
|
+
setUpDataConnector(params: Params$Resource$Projects$Locations$Setupdataconnector, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15185
|
+
setUpDataConnector(params: Params$Resource$Projects$Locations$Setupdataconnector, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15186
|
+
setUpDataConnector(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15187
|
+
/**
|
|
15188
|
+
* Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.
|
|
15189
|
+
* @example
|
|
15190
|
+
* ```js
|
|
15191
|
+
* // Before running the sample:
|
|
15192
|
+
* // - Enable the API at:
|
|
15193
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
15194
|
+
* // - Login into gcloud by running:
|
|
15195
|
+
* // ```sh
|
|
15196
|
+
* // $ gcloud auth application-default login
|
|
15197
|
+
* // ```
|
|
15198
|
+
* // - Install the npm module by running:
|
|
15199
|
+
* // ```sh
|
|
15200
|
+
* // $ npm install googleapis
|
|
15201
|
+
* // ```
|
|
15202
|
+
*
|
|
15203
|
+
* const {google} = require('googleapis');
|
|
15204
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
15205
|
+
*
|
|
15206
|
+
* async function main() {
|
|
15207
|
+
* const auth = new google.auth.GoogleAuth({
|
|
15208
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
15209
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
15210
|
+
* });
|
|
15211
|
+
*
|
|
15212
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
15213
|
+
* const authClient = await auth.getClient();
|
|
15214
|
+
* google.options({auth: authClient});
|
|
15215
|
+
*
|
|
15216
|
+
* // Do the magic
|
|
15217
|
+
* const res = await discoveryengine.projects.locations.setUpDataConnectorV2({
|
|
15218
|
+
* // Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
|
|
15219
|
+
* collectionDisplayName: 'placeholder-value',
|
|
15220
|
+
* // Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
15221
|
+
* collectionId: 'placeholder-value',
|
|
15222
|
+
* // Required. The parent of Collection, in the format of `projects/{project\}/locations/{location\}`.
|
|
15223
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
15224
|
+
*
|
|
15225
|
+
* // Request body metadata
|
|
15226
|
+
* requestBody: {
|
|
15227
|
+
* // request body parameters
|
|
15228
|
+
* // {
|
|
15229
|
+
* // "aclEnabled": false,
|
|
15230
|
+
* // "actionConfig": {},
|
|
15231
|
+
* // "actionState": "my_actionState",
|
|
15232
|
+
* // "alertPolicyConfigs": [],
|
|
15233
|
+
* // "autoRunDisabled": false,
|
|
15234
|
+
* // "bapConfig": {},
|
|
15235
|
+
* // "blockingReasons": [],
|
|
15236
|
+
* // "connectorModes": [],
|
|
15237
|
+
* // "connectorType": "my_connectorType",
|
|
15238
|
+
* // "createEuaSaas": false,
|
|
15239
|
+
* // "createTime": "my_createTime",
|
|
15240
|
+
* // "dataSource": "my_dataSource",
|
|
15241
|
+
* // "destinationConfigs": [],
|
|
15242
|
+
* // "endUserConfig": {},
|
|
15243
|
+
* // "entities": [],
|
|
15244
|
+
* // "errors": [],
|
|
15245
|
+
* // "federatedConfig": {},
|
|
15246
|
+
* // "hybridIngestionDisabled": false,
|
|
15247
|
+
* // "identityRefreshInterval": "my_identityRefreshInterval",
|
|
15248
|
+
* // "identityScheduleConfig": {},
|
|
15249
|
+
* // "incrementalRefreshInterval": "my_incrementalRefreshInterval",
|
|
15250
|
+
* // "incrementalSyncDisabled": false,
|
|
15251
|
+
* // "jsonParams": "my_jsonParams",
|
|
15252
|
+
* // "kmsKeyName": "my_kmsKeyName",
|
|
15253
|
+
* // "lastSyncTime": "my_lastSyncTime",
|
|
15254
|
+
* // "latestPauseTime": "my_latestPauseTime",
|
|
15255
|
+
* // "name": "my_name",
|
|
15256
|
+
* // "nextSyncTime": {},
|
|
15257
|
+
* // "params": {},
|
|
15258
|
+
* // "privateConnectivityProjectId": "my_privateConnectivityProjectId",
|
|
15259
|
+
* // "realtimeState": "my_realtimeState",
|
|
15260
|
+
* // "realtimeSyncConfig": {},
|
|
15261
|
+
* // "refreshInterval": "my_refreshInterval",
|
|
15262
|
+
* // "removeParamKeys": [],
|
|
15263
|
+
* // "state": "my_state",
|
|
15264
|
+
* // "staticIpAddresses": [],
|
|
15265
|
+
* // "staticIpEnabled": false,
|
|
15266
|
+
* // "syncMode": "my_syncMode",
|
|
15267
|
+
* // "updateTime": "my_updateTime"
|
|
15268
|
+
* // }
|
|
15269
|
+
* },
|
|
15270
|
+
* });
|
|
15271
|
+
* console.log(res.data);
|
|
15272
|
+
*
|
|
15273
|
+
* // Example response
|
|
15274
|
+
* // {
|
|
15275
|
+
* // "done": false,
|
|
15276
|
+
* // "error": {},
|
|
15277
|
+
* // "metadata": {},
|
|
15278
|
+
* // "name": "my_name",
|
|
15279
|
+
* // "response": {}
|
|
15280
|
+
* // }
|
|
15281
|
+
* }
|
|
15282
|
+
*
|
|
15283
|
+
* main().catch(e => {
|
|
15284
|
+
* console.error(e);
|
|
15285
|
+
* throw e;
|
|
15286
|
+
* });
|
|
15287
|
+
*
|
|
15288
|
+
* ```
|
|
15289
|
+
*
|
|
15290
|
+
* @param params - Parameters for request
|
|
15291
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
15292
|
+
* @param callback - Optional callback that handles the response.
|
|
15293
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
15294
|
+
*/
|
|
15295
|
+
setUpDataConnectorV2(params: Params$Resource$Projects$Locations$Setupdataconnectorv2, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
15296
|
+
setUpDataConnectorV2(params?: Params$Resource$Projects$Locations$Setupdataconnectorv2, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
15297
|
+
setUpDataConnectorV2(params: Params$Resource$Projects$Locations$Setupdataconnectorv2, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
15298
|
+
setUpDataConnectorV2(params: Params$Resource$Projects$Locations$Setupdataconnectorv2, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15299
|
+
setUpDataConnectorV2(params: Params$Resource$Projects$Locations$Setupdataconnectorv2, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15300
|
+
setUpDataConnectorV2(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15301
|
+
/**
|
|
15302
|
+
* Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.
|
|
15303
|
+
* @example
|
|
15304
|
+
* ```js
|
|
15305
|
+
* // Before running the sample:
|
|
15306
|
+
* // - Enable the API at:
|
|
15307
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
15308
|
+
* // - Login into gcloud by running:
|
|
15309
|
+
* // ```sh
|
|
15310
|
+
* // $ gcloud auth application-default login
|
|
15311
|
+
* // ```
|
|
15312
|
+
* // - Install the npm module by running:
|
|
15313
|
+
* // ```sh
|
|
15314
|
+
* // $ npm install googleapis
|
|
15315
|
+
* // ```
|
|
15316
|
+
*
|
|
15317
|
+
* const {google} = require('googleapis');
|
|
15318
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
15319
|
+
*
|
|
15320
|
+
* async function main() {
|
|
15321
|
+
* const auth = new google.auth.GoogleAuth({
|
|
15322
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
15323
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
15324
|
+
* });
|
|
15325
|
+
*
|
|
15326
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
15327
|
+
* const authClient = await auth.getClient();
|
|
15328
|
+
* google.options({auth: authClient});
|
|
15329
|
+
*
|
|
15330
|
+
* // Do the magic
|
|
15331
|
+
* const res = await discoveryengine.projects.locations.updateAclConfig({
|
|
15332
|
+
* // Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
15333
|
+
* name: 'projects/my-project/locations/my-location/aclConfig',
|
|
15334
|
+
*
|
|
15335
|
+
* // Request body metadata
|
|
15336
|
+
* requestBody: {
|
|
15337
|
+
* // request body parameters
|
|
15338
|
+
* // {
|
|
15339
|
+
* // "idpConfig": {},
|
|
15340
|
+
* // "name": "my_name"
|
|
15341
|
+
* // }
|
|
15342
|
+
* },
|
|
15343
|
+
* });
|
|
15344
|
+
* console.log(res.data);
|
|
15345
|
+
*
|
|
15346
|
+
* // Example response
|
|
15347
|
+
* // {
|
|
15348
|
+
* // "idpConfig": {},
|
|
15349
|
+
* // "name": "my_name"
|
|
15350
|
+
* // }
|
|
15351
|
+
* }
|
|
15352
|
+
*
|
|
15353
|
+
* main().catch(e => {
|
|
15354
|
+
* console.error(e);
|
|
15355
|
+
* throw e;
|
|
15356
|
+
* });
|
|
15357
|
+
*
|
|
15358
|
+
* ```
|
|
15359
|
+
*
|
|
15360
|
+
* @param params - Parameters for request
|
|
15361
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
15362
|
+
* @param callback - Optional callback that handles the response.
|
|
15363
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
15364
|
+
*/
|
|
15365
|
+
updateAclConfig(params: Params$Resource$Projects$Locations$Updateaclconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
15366
|
+
updateAclConfig(params?: Params$Resource$Projects$Locations$Updateaclconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1AclConfig>>;
|
|
15367
|
+
updateAclConfig(params: Params$Resource$Projects$Locations$Updateaclconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
15368
|
+
updateAclConfig(params: Params$Resource$Projects$Locations$Updateaclconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AclConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AclConfig>): void;
|
|
15369
|
+
updateAclConfig(params: Params$Resource$Projects$Locations$Updateaclconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AclConfig>): void;
|
|
15370
|
+
updateAclConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AclConfig>): void;
|
|
15371
|
+
/**
|
|
15372
|
+
* Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.
|
|
15373
|
+
* @example
|
|
15374
|
+
* ```js
|
|
15375
|
+
* // Before running the sample:
|
|
15376
|
+
* // - Enable the API at:
|
|
15377
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
15378
|
+
* // - Login into gcloud by running:
|
|
15379
|
+
* // ```sh
|
|
15380
|
+
* // $ gcloud auth application-default login
|
|
15381
|
+
* // ```
|
|
15382
|
+
* // - Install the npm module by running:
|
|
15383
|
+
* // ```sh
|
|
15384
|
+
* // $ npm install googleapis
|
|
15385
|
+
* // ```
|
|
15386
|
+
*
|
|
15387
|
+
* const {google} = require('googleapis');
|
|
15388
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
15389
|
+
*
|
|
15390
|
+
* async function main() {
|
|
15391
|
+
* const auth = new google.auth.GoogleAuth({
|
|
15392
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
15393
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
15394
|
+
* });
|
|
15395
|
+
*
|
|
15396
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
15397
|
+
* const authClient = await auth.getClient();
|
|
15398
|
+
* google.options({auth: authClient});
|
|
15399
|
+
*
|
|
15400
|
+
* // Do the magic
|
|
15401
|
+
* const res = await discoveryengine.projects.locations.updateCmekConfig({
|
|
15402
|
+
* // Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`.
|
|
15403
|
+
* name: 'projects/my-project/locations/my-location/cmekConfig',
|
|
15404
|
+
* // Set the following CmekConfig as the default to be used for child resources if one is not specified.
|
|
15405
|
+
* setDefault: 'placeholder-value',
|
|
15406
|
+
*
|
|
15407
|
+
* // Request body metadata
|
|
15408
|
+
* requestBody: {
|
|
15409
|
+
* // request body parameters
|
|
15410
|
+
* // {
|
|
15411
|
+
* // "isDefault": false,
|
|
15412
|
+
* // "kmsKey": "my_kmsKey",
|
|
15413
|
+
* // "kmsKeyVersion": "my_kmsKeyVersion",
|
|
15414
|
+
* // "lastRotationTimestampMicros": "my_lastRotationTimestampMicros",
|
|
15415
|
+
* // "name": "my_name",
|
|
15416
|
+
* // "notebooklmState": "my_notebooklmState",
|
|
15417
|
+
* // "singleRegionKeys": [],
|
|
15418
|
+
* // "state": "my_state"
|
|
15419
|
+
* // }
|
|
15420
|
+
* },
|
|
15421
|
+
* });
|
|
15422
|
+
* console.log(res.data);
|
|
15423
|
+
*
|
|
15424
|
+
* // Example response
|
|
15425
|
+
* // {
|
|
15426
|
+
* // "done": false,
|
|
15427
|
+
* // "error": {},
|
|
15428
|
+
* // "metadata": {},
|
|
15429
|
+
* // "name": "my_name",
|
|
15430
|
+
* // "response": {}
|
|
15431
|
+
* // }
|
|
15432
|
+
* }
|
|
15433
|
+
*
|
|
15434
|
+
* main().catch(e => {
|
|
15435
|
+
* console.error(e);
|
|
15436
|
+
* throw e;
|
|
15437
|
+
* });
|
|
15438
|
+
*
|
|
15439
|
+
* ```
|
|
15440
|
+
*
|
|
15441
|
+
* @param params - Parameters for request
|
|
15442
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
15443
|
+
* @param callback - Optional callback that handles the response.
|
|
15444
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
15445
|
+
*/
|
|
15446
|
+
updateCmekConfig(params: Params$Resource$Projects$Locations$Updatecmekconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
15447
|
+
updateCmekConfig(params?: Params$Resource$Projects$Locations$Updatecmekconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
15448
|
+
updateCmekConfig(params: Params$Resource$Projects$Locations$Updatecmekconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
15449
|
+
updateCmekConfig(params: Params$Resource$Projects$Locations$Updatecmekconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15450
|
+
updateCmekConfig(params: Params$Resource$Projects$Locations$Updatecmekconfig, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15451
|
+
updateCmekConfig(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15452
|
+
}
|
|
15453
|
+
export interface Params$Resource$Projects$Locations$Getaclconfig extends StandardParameters {
|
|
15454
|
+
/**
|
|
15455
|
+
* Required. Resource name of AclConfig, such as `projects/x/locations/x/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
15456
|
+
*/
|
|
15457
|
+
name?: string;
|
|
15458
|
+
}
|
|
15459
|
+
export interface Params$Resource$Projects$Locations$Getcmekconfig extends StandardParameters {
|
|
15460
|
+
/**
|
|
15461
|
+
* Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
15462
|
+
*/
|
|
15463
|
+
name?: string;
|
|
15464
|
+
}
|
|
15465
|
+
export interface Params$Resource$Projects$Locations$Setupdataconnector extends StandardParameters {
|
|
15466
|
+
/**
|
|
15467
|
+
* Required. The parent of Collection, in the format of `projects/{project\}/locations/{location\}`.
|
|
15468
|
+
*/
|
|
15469
|
+
parent?: string;
|
|
15470
|
+
/**
|
|
15471
|
+
* Request body metadata
|
|
15472
|
+
*/
|
|
15473
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest;
|
|
15474
|
+
}
|
|
15475
|
+
export interface Params$Resource$Projects$Locations$Setupdataconnectorv2 extends StandardParameters {
|
|
15476
|
+
/**
|
|
15477
|
+
* Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
|
|
15478
|
+
*/
|
|
15479
|
+
collectionDisplayName?: string;
|
|
15480
|
+
/**
|
|
15481
|
+
* Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
15482
|
+
*/
|
|
15483
|
+
collectionId?: string;
|
|
15484
|
+
/**
|
|
15485
|
+
* Required. The parent of Collection, in the format of `projects/{project\}/locations/{location\}`.
|
|
15486
|
+
*/
|
|
15487
|
+
parent?: string;
|
|
15488
|
+
/**
|
|
15489
|
+
* Request body metadata
|
|
15490
|
+
*/
|
|
15491
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1DataConnector;
|
|
15492
|
+
}
|
|
15493
|
+
export interface Params$Resource$Projects$Locations$Updateaclconfig extends StandardParameters {
|
|
15494
|
+
/**
|
|
15495
|
+
* Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
15496
|
+
*/
|
|
15497
|
+
name?: string;
|
|
15498
|
+
/**
|
|
15499
|
+
* Request body metadata
|
|
15500
|
+
*/
|
|
15501
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1AclConfig;
|
|
15502
|
+
}
|
|
15503
|
+
export interface Params$Resource$Projects$Locations$Updatecmekconfig extends StandardParameters {
|
|
15504
|
+
/**
|
|
15505
|
+
* Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`.
|
|
15506
|
+
*/
|
|
15507
|
+
name?: string;
|
|
15508
|
+
/**
|
|
15509
|
+
* Set the following CmekConfig as the default to be used for child resources if one is not specified.
|
|
15510
|
+
*/
|
|
15511
|
+
setDefault?: boolean;
|
|
15512
|
+
/**
|
|
15513
|
+
* Request body metadata
|
|
15514
|
+
*/
|
|
15515
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1CmekConfig;
|
|
15516
|
+
}
|
|
15517
|
+
export class Resource$Projects$Locations$Cmekconfigs {
|
|
15518
|
+
context: APIRequestContext;
|
|
15519
|
+
constructor(context: APIRequestContext);
|
|
15520
|
+
/**
|
|
15521
|
+
* De-provisions a CmekConfig.
|
|
15522
|
+
* @example
|
|
15523
|
+
* ```js
|
|
15524
|
+
* // Before running the sample:
|
|
15525
|
+
* // - Enable the API at:
|
|
15526
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
15527
|
+
* // - Login into gcloud by running:
|
|
15528
|
+
* // ```sh
|
|
15529
|
+
* // $ gcloud auth application-default login
|
|
15530
|
+
* // ```
|
|
15531
|
+
* // - Install the npm module by running:
|
|
15532
|
+
* // ```sh
|
|
15533
|
+
* // $ npm install googleapis
|
|
15534
|
+
* // ```
|
|
15535
|
+
*
|
|
15536
|
+
* const {google} = require('googleapis');
|
|
15537
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
15538
|
+
*
|
|
15539
|
+
* async function main() {
|
|
15540
|
+
* const auth = new google.auth.GoogleAuth({
|
|
15541
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
15542
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
15543
|
+
* });
|
|
15544
|
+
*
|
|
15545
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
15546
|
+
* const authClient = await auth.getClient();
|
|
15547
|
+
* google.options({auth: authClient});
|
|
15548
|
+
*
|
|
15549
|
+
* // Do the magic
|
|
15550
|
+
* const res = await discoveryengine.projects.locations.cmekConfigs.delete({
|
|
15551
|
+
* // Required. The resource name of the CmekConfig to delete, such as `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`.
|
|
15552
|
+
* name: 'projects/my-project/locations/my-location/cmekConfigs/my-cmekConfig',
|
|
15553
|
+
* });
|
|
15554
|
+
* console.log(res.data);
|
|
15555
|
+
*
|
|
15556
|
+
* // Example response
|
|
15557
|
+
* // {
|
|
15558
|
+
* // "done": false,
|
|
15559
|
+
* // "error": {},
|
|
15560
|
+
* // "metadata": {},
|
|
15561
|
+
* // "name": "my_name",
|
|
15562
|
+
* // "response": {}
|
|
15563
|
+
* // }
|
|
15564
|
+
* }
|
|
15565
|
+
*
|
|
15566
|
+
* main().catch(e => {
|
|
15567
|
+
* console.error(e);
|
|
15568
|
+
* throw e;
|
|
15569
|
+
* });
|
|
15570
|
+
*
|
|
15571
|
+
* ```
|
|
15572
|
+
*
|
|
15573
|
+
* @param params - Parameters for request
|
|
15574
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
15575
|
+
* @param callback - Optional callback that handles the response.
|
|
15576
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
15577
|
+
*/
|
|
15578
|
+
delete(params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
15579
|
+
delete(params?: Params$Resource$Projects$Locations$Cmekconfigs$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
15580
|
+
delete(params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
15581
|
+
delete(params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15582
|
+
delete(params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15583
|
+
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15584
|
+
/**
|
|
15585
|
+
* Gets the CmekConfig.
|
|
15586
|
+
* @example
|
|
15587
|
+
* ```js
|
|
15588
|
+
* // Before running the sample:
|
|
15589
|
+
* // - Enable the API at:
|
|
15590
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
15591
|
+
* // - Login into gcloud by running:
|
|
15592
|
+
* // ```sh
|
|
15593
|
+
* // $ gcloud auth application-default login
|
|
15594
|
+
* // ```
|
|
15595
|
+
* // - Install the npm module by running:
|
|
15596
|
+
* // ```sh
|
|
15597
|
+
* // $ npm install googleapis
|
|
15598
|
+
* // ```
|
|
15599
|
+
*
|
|
15600
|
+
* const {google} = require('googleapis');
|
|
15601
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
15602
|
+
*
|
|
15603
|
+
* async function main() {
|
|
15604
|
+
* const auth = new google.auth.GoogleAuth({
|
|
15605
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
15606
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
15607
|
+
* });
|
|
15608
|
+
*
|
|
15609
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
15610
|
+
* const authClient = await auth.getClient();
|
|
15611
|
+
* google.options({auth: authClient});
|
|
15612
|
+
*
|
|
15613
|
+
* // Do the magic
|
|
15614
|
+
* const res = await discoveryengine.projects.locations.cmekConfigs.get({
|
|
15615
|
+
* // Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
15616
|
+
* name: 'projects/my-project/locations/my-location/cmekConfigs/my-cmekConfig',
|
|
15617
|
+
* });
|
|
15618
|
+
* console.log(res.data);
|
|
15619
|
+
*
|
|
15620
|
+
* // Example response
|
|
15621
|
+
* // {
|
|
15622
|
+
* // "isDefault": false,
|
|
15623
|
+
* // "kmsKey": "my_kmsKey",
|
|
15624
|
+
* // "kmsKeyVersion": "my_kmsKeyVersion",
|
|
15625
|
+
* // "lastRotationTimestampMicros": "my_lastRotationTimestampMicros",
|
|
15626
|
+
* // "name": "my_name",
|
|
15627
|
+
* // "notebooklmState": "my_notebooklmState",
|
|
15628
|
+
* // "singleRegionKeys": [],
|
|
15629
|
+
* // "state": "my_state"
|
|
15630
|
+
* // }
|
|
15631
|
+
* }
|
|
15632
|
+
*
|
|
15633
|
+
* main().catch(e => {
|
|
15634
|
+
* console.error(e);
|
|
15635
|
+
* throw e;
|
|
15636
|
+
* });
|
|
15637
|
+
*
|
|
15638
|
+
* ```
|
|
15639
|
+
*
|
|
15640
|
+
* @param params - Parameters for request
|
|
15641
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
15642
|
+
* @param callback - Optional callback that handles the response.
|
|
15643
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
15644
|
+
*/
|
|
15645
|
+
get(params: Params$Resource$Projects$Locations$Cmekconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
15646
|
+
get(params?: Params$Resource$Projects$Locations$Cmekconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1CmekConfig>>;
|
|
15647
|
+
get(params: Params$Resource$Projects$Locations$Cmekconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
15648
|
+
get(params: Params$Resource$Projects$Locations$Cmekconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1CmekConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1CmekConfig>): void;
|
|
15649
|
+
get(params: Params$Resource$Projects$Locations$Cmekconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1CmekConfig>): void;
|
|
15650
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1CmekConfig>): void;
|
|
15651
|
+
/**
|
|
15652
|
+
* Lists all the CmekConfigs with the project.
|
|
15653
|
+
* @example
|
|
15654
|
+
* ```js
|
|
15655
|
+
* // Before running the sample:
|
|
15656
|
+
* // - Enable the API at:
|
|
15657
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
15658
|
+
* // - Login into gcloud by running:
|
|
15659
|
+
* // ```sh
|
|
15660
|
+
* // $ gcloud auth application-default login
|
|
15661
|
+
* // ```
|
|
15662
|
+
* // - Install the npm module by running:
|
|
15663
|
+
* // ```sh
|
|
15664
|
+
* // $ npm install googleapis
|
|
15665
|
+
* // ```
|
|
15666
|
+
*
|
|
15667
|
+
* const {google} = require('googleapis');
|
|
15668
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
15669
|
+
*
|
|
15670
|
+
* async function main() {
|
|
15671
|
+
* const auth = new google.auth.GoogleAuth({
|
|
15672
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
15673
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
15674
|
+
* });
|
|
15675
|
+
*
|
|
15676
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
15677
|
+
* const authClient = await auth.getClient();
|
|
15678
|
+
* google.options({auth: authClient});
|
|
15679
|
+
*
|
|
15680
|
+
* // Do the magic
|
|
15681
|
+
* const res = await discoveryengine.projects.locations.cmekConfigs.list({
|
|
15682
|
+
* // Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned.
|
|
15683
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
13583
15684
|
* });
|
|
13584
15685
|
* console.log(res.data);
|
|
13585
15686
|
*
|
|
13586
15687
|
* // Example response
|
|
13587
15688
|
* // {
|
|
13588
|
-
* // "
|
|
13589
|
-
* // "kmsKey": "my_kmsKey",
|
|
13590
|
-
* // "kmsKeyVersion": "my_kmsKeyVersion",
|
|
13591
|
-
* // "lastRotationTimestampMicros": "my_lastRotationTimestampMicros",
|
|
13592
|
-
* // "name": "my_name",
|
|
13593
|
-
* // "notebooklmState": "my_notebooklmState",
|
|
13594
|
-
* // "singleRegionKeys": [],
|
|
13595
|
-
* // "state": "my_state"
|
|
15689
|
+
* // "cmekConfigs": []
|
|
13596
15690
|
* // }
|
|
13597
15691
|
* }
|
|
13598
15692
|
*
|
|
@@ -13608,12 +15702,12 @@ export declare namespace discoveryengine_v1 {
|
|
|
13608
15702
|
* @param callback - Optional callback that handles the response.
|
|
13609
15703
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
13610
15704
|
*/
|
|
13611
|
-
|
|
13612
|
-
|
|
13613
|
-
|
|
13614
|
-
|
|
13615
|
-
|
|
13616
|
-
|
|
15705
|
+
list(params: Params$Resource$Projects$Locations$Cmekconfigs$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
15706
|
+
list(params?: Params$Resource$Projects$Locations$Cmekconfigs$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ListCmekConfigsResponse>>;
|
|
15707
|
+
list(params: Params$Resource$Projects$Locations$Cmekconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
15708
|
+
list(params: Params$Resource$Projects$Locations$Cmekconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListCmekConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListCmekConfigsResponse>): void;
|
|
15709
|
+
list(params: Params$Resource$Projects$Locations$Cmekconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListCmekConfigsResponse>): void;
|
|
15710
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListCmekConfigsResponse>): void;
|
|
13617
15711
|
/**
|
|
13618
15712
|
* Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.
|
|
13619
15713
|
* @example
|
|
@@ -13644,9 +15738,9 @@ export declare namespace discoveryengine_v1 {
|
|
|
13644
15738
|
* google.options({auth: authClient});
|
|
13645
15739
|
*
|
|
13646
15740
|
* // Do the magic
|
|
13647
|
-
* const res = await discoveryengine.projects.locations.
|
|
15741
|
+
* const res = await discoveryengine.projects.locations.cmekConfigs.patch({
|
|
13648
15742
|
* // Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`.
|
|
13649
|
-
* name: 'projects/my-project/locations/my-location/cmekConfig',
|
|
15743
|
+
* name: 'projects/my-project/locations/my-location/cmekConfigs/my-cmekConfig',
|
|
13650
15744
|
* // Set the following CmekConfig as the default to be used for child resources if one is not specified.
|
|
13651
15745
|
* setDefault: 'placeholder-value',
|
|
13652
15746
|
*
|
|
@@ -13689,20 +15783,32 @@ export declare namespace discoveryengine_v1 {
|
|
|
13689
15783
|
* @param callback - Optional callback that handles the response.
|
|
13690
15784
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
13691
15785
|
*/
|
|
13692
|
-
|
|
13693
|
-
|
|
13694
|
-
|
|
13695
|
-
|
|
13696
|
-
|
|
13697
|
-
|
|
15786
|
+
patch(params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
15787
|
+
patch(params?: Params$Resource$Projects$Locations$Cmekconfigs$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
15788
|
+
patch(params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
15789
|
+
patch(params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15790
|
+
patch(params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15791
|
+
patch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
13698
15792
|
}
|
|
13699
|
-
export interface Params$Resource$Projects$Locations$
|
|
15793
|
+
export interface Params$Resource$Projects$Locations$Cmekconfigs$Delete extends StandardParameters {
|
|
15794
|
+
/**
|
|
15795
|
+
* Required. The resource name of the CmekConfig to delete, such as `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`.
|
|
15796
|
+
*/
|
|
15797
|
+
name?: string;
|
|
15798
|
+
}
|
|
15799
|
+
export interface Params$Resource$Projects$Locations$Cmekconfigs$Get extends StandardParameters {
|
|
13700
15800
|
/**
|
|
13701
15801
|
* Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
13702
15802
|
*/
|
|
13703
15803
|
name?: string;
|
|
13704
15804
|
}
|
|
13705
|
-
export interface Params$Resource$Projects$Locations$
|
|
15805
|
+
export interface Params$Resource$Projects$Locations$Cmekconfigs$List extends StandardParameters {
|
|
15806
|
+
/**
|
|
15807
|
+
* Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned.
|
|
15808
|
+
*/
|
|
15809
|
+
parent?: string;
|
|
15810
|
+
}
|
|
15811
|
+
export interface Params$Resource$Projects$Locations$Cmekconfigs$Patch extends StandardParameters {
|
|
13706
15812
|
/**
|
|
13707
15813
|
* Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`.
|
|
13708
15814
|
*/
|
|
@@ -13716,11 +15822,15 @@ export declare namespace discoveryengine_v1 {
|
|
|
13716
15822
|
*/
|
|
13717
15823
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1CmekConfig;
|
|
13718
15824
|
}
|
|
13719
|
-
export class Resource$Projects$Locations$
|
|
15825
|
+
export class Resource$Projects$Locations$Collections {
|
|
13720
15826
|
context: APIRequestContext;
|
|
15827
|
+
dataConnector: Resource$Projects$Locations$Collections$Dataconnector;
|
|
15828
|
+
dataStores: Resource$Projects$Locations$Collections$Datastores;
|
|
15829
|
+
engines: Resource$Projects$Locations$Collections$Engines;
|
|
15830
|
+
operations: Resource$Projects$Locations$Collections$Operations;
|
|
13721
15831
|
constructor(context: APIRequestContext);
|
|
13722
15832
|
/**
|
|
13723
|
-
*
|
|
15833
|
+
* Deletes a Collection.
|
|
13724
15834
|
* @example
|
|
13725
15835
|
* ```js
|
|
13726
15836
|
* // Before running the sample:
|
|
@@ -13749,9 +15859,9 @@ export declare namespace discoveryengine_v1 {
|
|
|
13749
15859
|
* google.options({auth: authClient});
|
|
13750
15860
|
*
|
|
13751
15861
|
* // Do the magic
|
|
13752
|
-
* const res = await discoveryengine.projects.locations.
|
|
13753
|
-
* // Required. The resource name of the
|
|
13754
|
-
* name: 'projects/my-project/locations/my-location/
|
|
15862
|
+
* const res = await discoveryengine.projects.locations.collections.delete({
|
|
15863
|
+
* // Required. The full resource name of the Collection, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}`.
|
|
15864
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection',
|
|
13755
15865
|
* });
|
|
13756
15866
|
* console.log(res.data);
|
|
13757
15867
|
*
|
|
@@ -13777,14 +15887,14 @@ export declare namespace discoveryengine_v1 {
|
|
|
13777
15887
|
* @param callback - Optional callback that handles the response.
|
|
13778
15888
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
13779
15889
|
*/
|
|
13780
|
-
delete(params: Params$Resource$Projects$Locations$
|
|
13781
|
-
delete(params?: Params$Resource$Projects$Locations$
|
|
13782
|
-
delete(params: Params$Resource$Projects$Locations$
|
|
13783
|
-
delete(params: Params$Resource$Projects$Locations$
|
|
13784
|
-
delete(params: Params$Resource$Projects$Locations$
|
|
15890
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
15891
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
15892
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
15893
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15894
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
13785
15895
|
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
13786
15896
|
/**
|
|
13787
|
-
* Gets the
|
|
15897
|
+
* Gets the DataConnector. DataConnector is a singleton resource for each Collection.
|
|
13788
15898
|
* @example
|
|
13789
15899
|
* ```js
|
|
13790
15900
|
* // Before running the sample:
|
|
@@ -13813,82 +15923,54 @@ export declare namespace discoveryengine_v1 {
|
|
|
13813
15923
|
* google.options({auth: authClient});
|
|
13814
15924
|
*
|
|
13815
15925
|
* // Do the magic
|
|
13816
|
-
* const res =
|
|
13817
|
-
*
|
|
13818
|
-
*
|
|
13819
|
-
*
|
|
15926
|
+
* const res =
|
|
15927
|
+
* await discoveryengine.projects.locations.collections.getDataConnector({
|
|
15928
|
+
* // Required. Full resource name of DataConnector, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataConnector`. If the caller does not have permission to access the DataConnector, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataConnector does not exist, a NOT_FOUND error is returned.
|
|
15929
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector',
|
|
15930
|
+
* });
|
|
13820
15931
|
* console.log(res.data);
|
|
13821
15932
|
*
|
|
13822
15933
|
* // Example response
|
|
13823
15934
|
* // {
|
|
13824
|
-
* // "
|
|
13825
|
-
* // "
|
|
13826
|
-
* // "
|
|
13827
|
-
* // "
|
|
15935
|
+
* // "aclEnabled": false,
|
|
15936
|
+
* // "actionConfig": {},
|
|
15937
|
+
* // "actionState": "my_actionState",
|
|
15938
|
+
* // "alertPolicyConfigs": [],
|
|
15939
|
+
* // "autoRunDisabled": false,
|
|
15940
|
+
* // "bapConfig": {},
|
|
15941
|
+
* // "blockingReasons": [],
|
|
15942
|
+
* // "connectorModes": [],
|
|
15943
|
+
* // "connectorType": "my_connectorType",
|
|
15944
|
+
* // "createEuaSaas": false,
|
|
15945
|
+
* // "createTime": "my_createTime",
|
|
15946
|
+
* // "dataSource": "my_dataSource",
|
|
15947
|
+
* // "destinationConfigs": [],
|
|
15948
|
+
* // "endUserConfig": {},
|
|
15949
|
+
* // "entities": [],
|
|
15950
|
+
* // "errors": [],
|
|
15951
|
+
* // "federatedConfig": {},
|
|
15952
|
+
* // "hybridIngestionDisabled": false,
|
|
15953
|
+
* // "identityRefreshInterval": "my_identityRefreshInterval",
|
|
15954
|
+
* // "identityScheduleConfig": {},
|
|
15955
|
+
* // "incrementalRefreshInterval": "my_incrementalRefreshInterval",
|
|
15956
|
+
* // "incrementalSyncDisabled": false,
|
|
15957
|
+
* // "jsonParams": "my_jsonParams",
|
|
15958
|
+
* // "kmsKeyName": "my_kmsKeyName",
|
|
15959
|
+
* // "lastSyncTime": "my_lastSyncTime",
|
|
15960
|
+
* // "latestPauseTime": "my_latestPauseTime",
|
|
13828
15961
|
* // "name": "my_name",
|
|
13829
|
-
* // "
|
|
13830
|
-
* // "
|
|
13831
|
-
* // "
|
|
13832
|
-
* //
|
|
13833
|
-
* }
|
|
13834
|
-
*
|
|
13835
|
-
*
|
|
13836
|
-
*
|
|
13837
|
-
*
|
|
13838
|
-
*
|
|
13839
|
-
*
|
|
13840
|
-
*
|
|
13841
|
-
*
|
|
13842
|
-
* @param params - Parameters for request
|
|
13843
|
-
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
13844
|
-
* @param callback - Optional callback that handles the response.
|
|
13845
|
-
* @returns A promise if used with async/await, or void if used with a callback.
|
|
13846
|
-
*/
|
|
13847
|
-
get(params: Params$Resource$Projects$Locations$Cmekconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
13848
|
-
get(params?: Params$Resource$Projects$Locations$Cmekconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1CmekConfig>>;
|
|
13849
|
-
get(params: Params$Resource$Projects$Locations$Cmekconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
13850
|
-
get(params: Params$Resource$Projects$Locations$Cmekconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1CmekConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1CmekConfig>): void;
|
|
13851
|
-
get(params: Params$Resource$Projects$Locations$Cmekconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1CmekConfig>): void;
|
|
13852
|
-
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1CmekConfig>): void;
|
|
13853
|
-
/**
|
|
13854
|
-
* Lists all the CmekConfigs with the project.
|
|
13855
|
-
* @example
|
|
13856
|
-
* ```js
|
|
13857
|
-
* // Before running the sample:
|
|
13858
|
-
* // - Enable the API at:
|
|
13859
|
-
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
13860
|
-
* // - Login into gcloud by running:
|
|
13861
|
-
* // ```sh
|
|
13862
|
-
* // $ gcloud auth application-default login
|
|
13863
|
-
* // ```
|
|
13864
|
-
* // - Install the npm module by running:
|
|
13865
|
-
* // ```sh
|
|
13866
|
-
* // $ npm install googleapis
|
|
13867
|
-
* // ```
|
|
13868
|
-
*
|
|
13869
|
-
* const {google} = require('googleapis');
|
|
13870
|
-
* const discoveryengine = google.discoveryengine('v1');
|
|
13871
|
-
*
|
|
13872
|
-
* async function main() {
|
|
13873
|
-
* const auth = new google.auth.GoogleAuth({
|
|
13874
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
13875
|
-
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
13876
|
-
* });
|
|
13877
|
-
*
|
|
13878
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
13879
|
-
* const authClient = await auth.getClient();
|
|
13880
|
-
* google.options({auth: authClient});
|
|
13881
|
-
*
|
|
13882
|
-
* // Do the magic
|
|
13883
|
-
* const res = await discoveryengine.projects.locations.cmekConfigs.list({
|
|
13884
|
-
* // Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned.
|
|
13885
|
-
* parent: 'projects/my-project/locations/my-location',
|
|
13886
|
-
* });
|
|
13887
|
-
* console.log(res.data);
|
|
13888
|
-
*
|
|
13889
|
-
* // Example response
|
|
13890
|
-
* // {
|
|
13891
|
-
* // "cmekConfigs": []
|
|
15962
|
+
* // "nextSyncTime": {},
|
|
15963
|
+
* // "params": {},
|
|
15964
|
+
* // "privateConnectivityProjectId": "my_privateConnectivityProjectId",
|
|
15965
|
+
* // "realtimeState": "my_realtimeState",
|
|
15966
|
+
* // "realtimeSyncConfig": {},
|
|
15967
|
+
* // "refreshInterval": "my_refreshInterval",
|
|
15968
|
+
* // "removeParamKeys": [],
|
|
15969
|
+
* // "state": "my_state",
|
|
15970
|
+
* // "staticIpAddresses": [],
|
|
15971
|
+
* // "staticIpEnabled": false,
|
|
15972
|
+
* // "syncMode": "my_syncMode",
|
|
15973
|
+
* // "updateTime": "my_updateTime"
|
|
13892
15974
|
* // }
|
|
13893
15975
|
* }
|
|
13894
15976
|
*
|
|
@@ -13904,14 +15986,14 @@ export declare namespace discoveryengine_v1 {
|
|
|
13904
15986
|
* @param callback - Optional callback that handles the response.
|
|
13905
15987
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
13906
15988
|
*/
|
|
13907
|
-
|
|
13908
|
-
|
|
13909
|
-
|
|
13910
|
-
|
|
13911
|
-
|
|
13912
|
-
|
|
15989
|
+
getDataConnector(params: Params$Resource$Projects$Locations$Collections$Getdataconnector, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
15990
|
+
getDataConnector(params?: Params$Resource$Projects$Locations$Collections$Getdataconnector, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1DataConnector>>;
|
|
15991
|
+
getDataConnector(params: Params$Resource$Projects$Locations$Collections$Getdataconnector, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
15992
|
+
getDataConnector(params: Params$Resource$Projects$Locations$Collections$Getdataconnector, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1DataConnector>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1DataConnector>): void;
|
|
15993
|
+
getDataConnector(params: Params$Resource$Projects$Locations$Collections$Getdataconnector, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1DataConnector>): void;
|
|
15994
|
+
getDataConnector(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1DataConnector>): void;
|
|
13913
15995
|
/**
|
|
13914
|
-
*
|
|
15996
|
+
* Updates a DataConnector.
|
|
13915
15997
|
* @example
|
|
13916
15998
|
* ```js
|
|
13917
15999
|
* // Before running the sample:
|
|
@@ -13940,36 +16022,102 @@ export declare namespace discoveryengine_v1 {
|
|
|
13940
16022
|
* google.options({auth: authClient});
|
|
13941
16023
|
*
|
|
13942
16024
|
* // Do the magic
|
|
13943
|
-
* const res =
|
|
13944
|
-
*
|
|
13945
|
-
*
|
|
13946
|
-
*
|
|
13947
|
-
*
|
|
16025
|
+
* const res =
|
|
16026
|
+
* await discoveryengine.projects.locations.collections.updateDataConnector({
|
|
16027
|
+
* // Output only. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`.
|
|
16028
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector',
|
|
16029
|
+
* // Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.
|
|
16030
|
+
* updateMask: 'placeholder-value',
|
|
13948
16031
|
*
|
|
13949
|
-
*
|
|
13950
|
-
*
|
|
13951
|
-
*
|
|
13952
|
-
*
|
|
13953
|
-
*
|
|
13954
|
-
*
|
|
13955
|
-
*
|
|
13956
|
-
*
|
|
13957
|
-
*
|
|
13958
|
-
*
|
|
13959
|
-
*
|
|
13960
|
-
*
|
|
13961
|
-
*
|
|
13962
|
-
*
|
|
13963
|
-
*
|
|
16032
|
+
* // Request body metadata
|
|
16033
|
+
* requestBody: {
|
|
16034
|
+
* // request body parameters
|
|
16035
|
+
* // {
|
|
16036
|
+
* // "aclEnabled": false,
|
|
16037
|
+
* // "actionConfig": {},
|
|
16038
|
+
* // "actionState": "my_actionState",
|
|
16039
|
+
* // "alertPolicyConfigs": [],
|
|
16040
|
+
* // "autoRunDisabled": false,
|
|
16041
|
+
* // "bapConfig": {},
|
|
16042
|
+
* // "blockingReasons": [],
|
|
16043
|
+
* // "connectorModes": [],
|
|
16044
|
+
* // "connectorType": "my_connectorType",
|
|
16045
|
+
* // "createEuaSaas": false,
|
|
16046
|
+
* // "createTime": "my_createTime",
|
|
16047
|
+
* // "dataSource": "my_dataSource",
|
|
16048
|
+
* // "destinationConfigs": [],
|
|
16049
|
+
* // "endUserConfig": {},
|
|
16050
|
+
* // "entities": [],
|
|
16051
|
+
* // "errors": [],
|
|
16052
|
+
* // "federatedConfig": {},
|
|
16053
|
+
* // "hybridIngestionDisabled": false,
|
|
16054
|
+
* // "identityRefreshInterval": "my_identityRefreshInterval",
|
|
16055
|
+
* // "identityScheduleConfig": {},
|
|
16056
|
+
* // "incrementalRefreshInterval": "my_incrementalRefreshInterval",
|
|
16057
|
+
* // "incrementalSyncDisabled": false,
|
|
16058
|
+
* // "jsonParams": "my_jsonParams",
|
|
16059
|
+
* // "kmsKeyName": "my_kmsKeyName",
|
|
16060
|
+
* // "lastSyncTime": "my_lastSyncTime",
|
|
16061
|
+
* // "latestPauseTime": "my_latestPauseTime",
|
|
16062
|
+
* // "name": "my_name",
|
|
16063
|
+
* // "nextSyncTime": {},
|
|
16064
|
+
* // "params": {},
|
|
16065
|
+
* // "privateConnectivityProjectId": "my_privateConnectivityProjectId",
|
|
16066
|
+
* // "realtimeState": "my_realtimeState",
|
|
16067
|
+
* // "realtimeSyncConfig": {},
|
|
16068
|
+
* // "refreshInterval": "my_refreshInterval",
|
|
16069
|
+
* // "removeParamKeys": [],
|
|
16070
|
+
* // "state": "my_state",
|
|
16071
|
+
* // "staticIpAddresses": [],
|
|
16072
|
+
* // "staticIpEnabled": false,
|
|
16073
|
+
* // "syncMode": "my_syncMode",
|
|
16074
|
+
* // "updateTime": "my_updateTime"
|
|
16075
|
+
* // }
|
|
16076
|
+
* },
|
|
16077
|
+
* });
|
|
13964
16078
|
* console.log(res.data);
|
|
13965
16079
|
*
|
|
13966
16080
|
* // Example response
|
|
13967
16081
|
* // {
|
|
13968
|
-
* // "
|
|
13969
|
-
* // "
|
|
13970
|
-
* // "
|
|
16082
|
+
* // "aclEnabled": false,
|
|
16083
|
+
* // "actionConfig": {},
|
|
16084
|
+
* // "actionState": "my_actionState",
|
|
16085
|
+
* // "alertPolicyConfigs": [],
|
|
16086
|
+
* // "autoRunDisabled": false,
|
|
16087
|
+
* // "bapConfig": {},
|
|
16088
|
+
* // "blockingReasons": [],
|
|
16089
|
+
* // "connectorModes": [],
|
|
16090
|
+
* // "connectorType": "my_connectorType",
|
|
16091
|
+
* // "createEuaSaas": false,
|
|
16092
|
+
* // "createTime": "my_createTime",
|
|
16093
|
+
* // "dataSource": "my_dataSource",
|
|
16094
|
+
* // "destinationConfigs": [],
|
|
16095
|
+
* // "endUserConfig": {},
|
|
16096
|
+
* // "entities": [],
|
|
16097
|
+
* // "errors": [],
|
|
16098
|
+
* // "federatedConfig": {},
|
|
16099
|
+
* // "hybridIngestionDisabled": false,
|
|
16100
|
+
* // "identityRefreshInterval": "my_identityRefreshInterval",
|
|
16101
|
+
* // "identityScheduleConfig": {},
|
|
16102
|
+
* // "incrementalRefreshInterval": "my_incrementalRefreshInterval",
|
|
16103
|
+
* // "incrementalSyncDisabled": false,
|
|
16104
|
+
* // "jsonParams": "my_jsonParams",
|
|
16105
|
+
* // "kmsKeyName": "my_kmsKeyName",
|
|
16106
|
+
* // "lastSyncTime": "my_lastSyncTime",
|
|
16107
|
+
* // "latestPauseTime": "my_latestPauseTime",
|
|
13971
16108
|
* // "name": "my_name",
|
|
13972
|
-
* // "
|
|
16109
|
+
* // "nextSyncTime": {},
|
|
16110
|
+
* // "params": {},
|
|
16111
|
+
* // "privateConnectivityProjectId": "my_privateConnectivityProjectId",
|
|
16112
|
+
* // "realtimeState": "my_realtimeState",
|
|
16113
|
+
* // "realtimeSyncConfig": {},
|
|
16114
|
+
* // "refreshInterval": "my_refreshInterval",
|
|
16115
|
+
* // "removeParamKeys": [],
|
|
16116
|
+
* // "state": "my_state",
|
|
16117
|
+
* // "staticIpAddresses": [],
|
|
16118
|
+
* // "staticIpEnabled": false,
|
|
16119
|
+
* // "syncMode": "my_syncMode",
|
|
16120
|
+
* // "updateTime": "my_updateTime"
|
|
13973
16121
|
* // }
|
|
13974
16122
|
* }
|
|
13975
16123
|
*
|
|
@@ -13985,52 +16133,38 @@ export declare namespace discoveryengine_v1 {
|
|
|
13985
16133
|
* @param callback - Optional callback that handles the response.
|
|
13986
16134
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
13987
16135
|
*/
|
|
13988
|
-
|
|
13989
|
-
|
|
13990
|
-
|
|
13991
|
-
|
|
13992
|
-
|
|
13993
|
-
|
|
16136
|
+
updateDataConnector(params: Params$Resource$Projects$Locations$Collections$Updatedataconnector, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
16137
|
+
updateDataConnector(params?: Params$Resource$Projects$Locations$Collections$Updatedataconnector, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1DataConnector>>;
|
|
16138
|
+
updateDataConnector(params: Params$Resource$Projects$Locations$Collections$Updatedataconnector, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
16139
|
+
updateDataConnector(params: Params$Resource$Projects$Locations$Collections$Updatedataconnector, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1DataConnector>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1DataConnector>): void;
|
|
16140
|
+
updateDataConnector(params: Params$Resource$Projects$Locations$Collections$Updatedataconnector, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1DataConnector>): void;
|
|
16141
|
+
updateDataConnector(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1DataConnector>): void;
|
|
13994
16142
|
}
|
|
13995
|
-
export interface Params$Resource$Projects$Locations$
|
|
16143
|
+
export interface Params$Resource$Projects$Locations$Collections$Delete extends StandardParameters {
|
|
13996
16144
|
/**
|
|
13997
|
-
* Required. The resource name of the
|
|
16145
|
+
* Required. The full resource name of the Collection, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}`.
|
|
13998
16146
|
*/
|
|
13999
16147
|
name?: string;
|
|
14000
16148
|
}
|
|
14001
|
-
export interface Params$Resource$Projects$Locations$
|
|
16149
|
+
export interface Params$Resource$Projects$Locations$Collections$Getdataconnector extends StandardParameters {
|
|
14002
16150
|
/**
|
|
14003
|
-
* Required.
|
|
16151
|
+
* Required. Full resource name of DataConnector, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataConnector`. If the caller does not have permission to access the DataConnector, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataConnector does not exist, a NOT_FOUND error is returned.
|
|
14004
16152
|
*/
|
|
14005
16153
|
name?: string;
|
|
14006
16154
|
}
|
|
14007
|
-
export interface Params$Resource$Projects$Locations$
|
|
14008
|
-
/**
|
|
14009
|
-
* Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned.
|
|
14010
|
-
*/
|
|
14011
|
-
parent?: string;
|
|
14012
|
-
}
|
|
14013
|
-
export interface Params$Resource$Projects$Locations$Cmekconfigs$Patch extends StandardParameters {
|
|
16155
|
+
export interface Params$Resource$Projects$Locations$Collections$Updatedataconnector extends StandardParameters {
|
|
14014
16156
|
/**
|
|
14015
|
-
*
|
|
16157
|
+
* Output only. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`.
|
|
14016
16158
|
*/
|
|
14017
16159
|
name?: string;
|
|
14018
16160
|
/**
|
|
14019
|
-
*
|
|
16161
|
+
* Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.
|
|
14020
16162
|
*/
|
|
14021
|
-
|
|
16163
|
+
updateMask?: string;
|
|
14022
16164
|
/**
|
|
14023
16165
|
* Request body metadata
|
|
14024
16166
|
*/
|
|
14025
|
-
requestBody?: Schema$
|
|
14026
|
-
}
|
|
14027
|
-
export class Resource$Projects$Locations$Collections {
|
|
14028
|
-
context: APIRequestContext;
|
|
14029
|
-
dataConnector: Resource$Projects$Locations$Collections$Dataconnector;
|
|
14030
|
-
dataStores: Resource$Projects$Locations$Collections$Datastores;
|
|
14031
|
-
engines: Resource$Projects$Locations$Collections$Engines;
|
|
14032
|
-
operations: Resource$Projects$Locations$Collections$Operations;
|
|
14033
|
-
constructor(context: APIRequestContext);
|
|
16167
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1DataConnector;
|
|
14034
16168
|
}
|
|
14035
16169
|
export class Resource$Projects$Locations$Collections$Dataconnector {
|
|
14036
16170
|
context: APIRequestContext;
|
|
@@ -14148,6 +16282,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
14148
16282
|
* pageSize: 'placeholder-value',
|
|
14149
16283
|
* // The standard list page token.
|
|
14150
16284
|
* pageToken: 'placeholder-value',
|
|
16285
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
16286
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
14151
16287
|
* },
|
|
14152
16288
|
* );
|
|
14153
16289
|
* console.log(res.data);
|
|
@@ -14155,7 +16291,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
14155
16291
|
* // Example response
|
|
14156
16292
|
* // {
|
|
14157
16293
|
* // "nextPageToken": "my_nextPageToken",
|
|
14158
|
-
* // "operations": []
|
|
16294
|
+
* // "operations": [],
|
|
16295
|
+
* // "unreachable": []
|
|
14159
16296
|
* // }
|
|
14160
16297
|
* }
|
|
14161
16298
|
*
|
|
@@ -14201,6 +16338,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
14201
16338
|
* The standard list page token.
|
|
14202
16339
|
*/
|
|
14203
16340
|
pageToken?: string;
|
|
16341
|
+
/**
|
|
16342
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
16343
|
+
*/
|
|
16344
|
+
returnPartialSuccess?: boolean;
|
|
14204
16345
|
}
|
|
14205
16346
|
export class Resource$Projects$Locations$Collections$Datastores {
|
|
14206
16347
|
context: APIRequestContext;
|
|
@@ -14346,6 +16487,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
14346
16487
|
* // "advancedSiteSearchConfig": {},
|
|
14347
16488
|
* // "billingEstimation": {},
|
|
14348
16489
|
* // "cmekConfig": {},
|
|
16490
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
14349
16491
|
* // "contentConfig": "my_contentConfig",
|
|
14350
16492
|
* // "createTime": "my_createTime",
|
|
14351
16493
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -14502,6 +16644,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
14502
16644
|
* // "advancedSiteSearchConfig": {},
|
|
14503
16645
|
* // "billingEstimation": {},
|
|
14504
16646
|
* // "cmekConfig": {},
|
|
16647
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
14505
16648
|
* // "contentConfig": "my_contentConfig",
|
|
14506
16649
|
* // "createTime": "my_createTime",
|
|
14507
16650
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -14715,6 +16858,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
14715
16858
|
* // "advancedSiteSearchConfig": {},
|
|
14716
16859
|
* // "billingEstimation": {},
|
|
14717
16860
|
* // "cmekConfig": {},
|
|
16861
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
14718
16862
|
* // "contentConfig": "my_contentConfig",
|
|
14719
16863
|
* // "createTime": "my_createTime",
|
|
14720
16864
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -14741,6 +16885,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
14741
16885
|
* // "advancedSiteSearchConfig": {},
|
|
14742
16886
|
* // "billingEstimation": {},
|
|
14743
16887
|
* // "cmekConfig": {},
|
|
16888
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
14744
16889
|
* // "contentConfig": "my_contentConfig",
|
|
14745
16890
|
* // "createTime": "my_createTime",
|
|
14746
16891
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -15879,6 +18024,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
15879
18024
|
* pageSize: 'placeholder-value',
|
|
15880
18025
|
* // The standard list page token.
|
|
15881
18026
|
* pageToken: 'placeholder-value',
|
|
18027
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
18028
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
15882
18029
|
* },
|
|
15883
18030
|
* );
|
|
15884
18031
|
* console.log(res.data);
|
|
@@ -15886,7 +18033,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
15886
18033
|
* // Example response
|
|
15887
18034
|
* // {
|
|
15888
18035
|
* // "nextPageToken": "my_nextPageToken",
|
|
15889
|
-
* // "operations": []
|
|
18036
|
+
* // "operations": [],
|
|
18037
|
+
* // "unreachable": []
|
|
15890
18038
|
* // }
|
|
15891
18039
|
* }
|
|
15892
18040
|
*
|
|
@@ -15942,6 +18090,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
15942
18090
|
* The standard list page token.
|
|
15943
18091
|
*/
|
|
15944
18092
|
pageToken?: string;
|
|
18093
|
+
/**
|
|
18094
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
18095
|
+
*/
|
|
18096
|
+
returnPartialSuccess?: boolean;
|
|
15945
18097
|
}
|
|
15946
18098
|
export class Resource$Projects$Locations$Collections$Datastores$Completionconfig {
|
|
15947
18099
|
context: APIRequestContext;
|
|
@@ -17384,6 +19536,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
17384
19536
|
* pageSize: 'placeholder-value',
|
|
17385
19537
|
* // The standard list page token.
|
|
17386
19538
|
* pageToken: 'placeholder-value',
|
|
19539
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
19540
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
17387
19541
|
* },
|
|
17388
19542
|
* );
|
|
17389
19543
|
* console.log(res.data);
|
|
@@ -17391,7 +19545,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
17391
19545
|
* // Example response
|
|
17392
19546
|
* // {
|
|
17393
19547
|
* // "nextPageToken": "my_nextPageToken",
|
|
17394
|
-
* // "operations": []
|
|
19548
|
+
* // "operations": [],
|
|
19549
|
+
* // "unreachable": []
|
|
17395
19550
|
* // }
|
|
17396
19551
|
* }
|
|
17397
19552
|
*
|
|
@@ -17437,6 +19592,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
17437
19592
|
* The standard list page token.
|
|
17438
19593
|
*/
|
|
17439
19594
|
pageToken?: string;
|
|
19595
|
+
/**
|
|
19596
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
19597
|
+
*/
|
|
19598
|
+
returnPartialSuccess?: boolean;
|
|
17440
19599
|
}
|
|
17441
19600
|
export class Resource$Projects$Locations$Collections$Datastores$Operations {
|
|
17442
19601
|
context: APIRequestContext;
|
|
@@ -17549,6 +19708,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
17549
19708
|
* pageSize: 'placeholder-value',
|
|
17550
19709
|
* // The standard list page token.
|
|
17551
19710
|
* pageToken: 'placeholder-value',
|
|
19711
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
19712
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
17552
19713
|
* },
|
|
17553
19714
|
* );
|
|
17554
19715
|
* console.log(res.data);
|
|
@@ -17556,7 +19717,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
17556
19717
|
* // Example response
|
|
17557
19718
|
* // {
|
|
17558
19719
|
* // "nextPageToken": "my_nextPageToken",
|
|
17559
|
-
* // "operations": []
|
|
19720
|
+
* // "operations": [],
|
|
19721
|
+
* // "unreachable": []
|
|
17560
19722
|
* // }
|
|
17561
19723
|
* }
|
|
17562
19724
|
*
|
|
@@ -17602,6 +19764,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
17602
19764
|
* The standard list page token.
|
|
17603
19765
|
*/
|
|
17604
19766
|
pageToken?: string;
|
|
19767
|
+
/**
|
|
19768
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
19769
|
+
*/
|
|
19770
|
+
returnPartialSuccess?: boolean;
|
|
17605
19771
|
}
|
|
17606
19772
|
export class Resource$Projects$Locations$Collections$Datastores$Schemas {
|
|
17607
19773
|
context: APIRequestContext;
|
|
@@ -18133,6 +20299,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
18133
20299
|
* pageSize: 'placeholder-value',
|
|
18134
20300
|
* // The standard list page token.
|
|
18135
20301
|
* pageToken: 'placeholder-value',
|
|
20302
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
20303
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
18136
20304
|
* },
|
|
18137
20305
|
* );
|
|
18138
20306
|
* console.log(res.data);
|
|
@@ -18140,7 +20308,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
18140
20308
|
* // Example response
|
|
18141
20309
|
* // {
|
|
18142
20310
|
* // "nextPageToken": "my_nextPageToken",
|
|
18143
|
-
* // "operations": []
|
|
20311
|
+
* // "operations": [],
|
|
20312
|
+
* // "unreachable": []
|
|
18144
20313
|
* // }
|
|
18145
20314
|
* }
|
|
18146
20315
|
*
|
|
@@ -18186,6 +20355,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
18186
20355
|
* The standard list page token.
|
|
18187
20356
|
*/
|
|
18188
20357
|
pageToken?: string;
|
|
20358
|
+
/**
|
|
20359
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
20360
|
+
*/
|
|
20361
|
+
returnPartialSuccess?: boolean;
|
|
18189
20362
|
}
|
|
18190
20363
|
export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs {
|
|
18191
20364
|
context: APIRequestContext;
|
|
@@ -18517,6 +20690,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
18517
20690
|
* // "filter": "my_filter",
|
|
18518
20691
|
* // "imageQuery": {},
|
|
18519
20692
|
* // "languageCode": "my_languageCode",
|
|
20693
|
+
* // "naturalLanguageQueryUnderstandingSpec": {},
|
|
18520
20694
|
* // "offset": 0,
|
|
18521
20695
|
* // "oneBoxPageSize": 0,
|
|
18522
20696
|
* // "orderBy": "my_orderBy",
|
|
@@ -18628,6 +20802,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
18628
20802
|
* // "filter": "my_filter",
|
|
18629
20803
|
* // "imageQuery": {},
|
|
18630
20804
|
* // "languageCode": "my_languageCode",
|
|
20805
|
+
* // "naturalLanguageQueryUnderstandingSpec": {},
|
|
18631
20806
|
* // "offset": 0,
|
|
18632
20807
|
* // "oneBoxPageSize": 0,
|
|
18633
20808
|
* // "orderBy": "my_orderBy",
|
|
@@ -19911,6 +22086,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
19911
22086
|
* pageSize: 'placeholder-value',
|
|
19912
22087
|
* // The standard list page token.
|
|
19913
22088
|
* pageToken: 'placeholder-value',
|
|
22089
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
22090
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
19914
22091
|
* },
|
|
19915
22092
|
* );
|
|
19916
22093
|
* console.log(res.data);
|
|
@@ -19918,7 +22095,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
19918
22095
|
* // Example response
|
|
19919
22096
|
* // {
|
|
19920
22097
|
* // "nextPageToken": "my_nextPageToken",
|
|
19921
|
-
* // "operations": []
|
|
22098
|
+
* // "operations": [],
|
|
22099
|
+
* // "unreachable": []
|
|
19922
22100
|
* // }
|
|
19923
22101
|
* }
|
|
19924
22102
|
*
|
|
@@ -19964,6 +22142,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
19964
22142
|
* The standard list page token.
|
|
19965
22143
|
*/
|
|
19966
22144
|
pageToken?: string;
|
|
22145
|
+
/**
|
|
22146
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
22147
|
+
*/
|
|
22148
|
+
returnPartialSuccess?: boolean;
|
|
19967
22149
|
}
|
|
19968
22150
|
export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps {
|
|
19969
22151
|
context: APIRequestContext;
|
|
@@ -20832,6 +23014,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
20832
23014
|
* pageSize: 'placeholder-value',
|
|
20833
23015
|
* // The standard list page token.
|
|
20834
23016
|
* pageToken: 'placeholder-value',
|
|
23017
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
23018
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
20835
23019
|
* },
|
|
20836
23020
|
* );
|
|
20837
23021
|
* console.log(res.data);
|
|
@@ -20839,7 +23023,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
20839
23023
|
* // Example response
|
|
20840
23024
|
* // {
|
|
20841
23025
|
* // "nextPageToken": "my_nextPageToken",
|
|
20842
|
-
* // "operations": []
|
|
23026
|
+
* // "operations": [],
|
|
23027
|
+
* // "unreachable": []
|
|
20843
23028
|
* // }
|
|
20844
23029
|
* }
|
|
20845
23030
|
*
|
|
@@ -20885,6 +23070,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
20885
23070
|
* The standard list page token.
|
|
20886
23071
|
*/
|
|
20887
23072
|
pageToken?: string;
|
|
23073
|
+
/**
|
|
23074
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
23075
|
+
*/
|
|
23076
|
+
returnPartialSuccess?: boolean;
|
|
20888
23077
|
}
|
|
20889
23078
|
export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries {
|
|
20890
23079
|
context: APIRequestContext;
|
|
@@ -21513,9 +23702,11 @@ export declare namespace discoveryengine_v1 {
|
|
|
21513
23702
|
* requestBody: {
|
|
21514
23703
|
* // request body parameters
|
|
21515
23704
|
* // {
|
|
23705
|
+
* // "appType": "my_appType",
|
|
21516
23706
|
* // "chatEngineConfig": {},
|
|
21517
23707
|
* // "chatEngineMetadata": {},
|
|
21518
23708
|
* // "commonConfig": {},
|
|
23709
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
21519
23710
|
* // "createTime": "my_createTime",
|
|
21520
23711
|
* // "dataStoreIds": [],
|
|
21521
23712
|
* // "disableAnalytics": false,
|
|
@@ -21663,9 +23854,11 @@ export declare namespace discoveryengine_v1 {
|
|
|
21663
23854
|
*
|
|
21664
23855
|
* // Example response
|
|
21665
23856
|
* // {
|
|
23857
|
+
* // "appType": "my_appType",
|
|
21666
23858
|
* // "chatEngineConfig": {},
|
|
21667
23859
|
* // "chatEngineMetadata": {},
|
|
21668
23860
|
* // "commonConfig": {},
|
|
23861
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
21669
23862
|
* // "createTime": "my_createTime",
|
|
21670
23863
|
* // "dataStoreIds": [],
|
|
21671
23864
|
* // "disableAnalytics": false,
|
|
@@ -21809,9 +24002,11 @@ export declare namespace discoveryengine_v1 {
|
|
|
21809
24002
|
* requestBody: {
|
|
21810
24003
|
* // request body parameters
|
|
21811
24004
|
* // {
|
|
24005
|
+
* // "appType": "my_appType",
|
|
21812
24006
|
* // "chatEngineConfig": {},
|
|
21813
24007
|
* // "chatEngineMetadata": {},
|
|
21814
24008
|
* // "commonConfig": {},
|
|
24009
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
21815
24010
|
* // "createTime": "my_createTime",
|
|
21816
24011
|
* // "dataStoreIds": [],
|
|
21817
24012
|
* // "disableAnalytics": false,
|
|
@@ -21830,9 +24025,11 @@ export declare namespace discoveryengine_v1 {
|
|
|
21830
24025
|
*
|
|
21831
24026
|
* // Example response
|
|
21832
24027
|
* // {
|
|
24028
|
+
* // "appType": "my_appType",
|
|
21833
24029
|
* // "chatEngineConfig": {},
|
|
21834
24030
|
* // "chatEngineMetadata": {},
|
|
21835
24031
|
* // "commonConfig": {},
|
|
24032
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
21836
24033
|
* // "createTime": "my_createTime",
|
|
21837
24034
|
* // "dataStoreIds": [],
|
|
21838
24035
|
* // "disableAnalytics": false,
|
|
@@ -23431,6 +25628,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
23431
25628
|
* pageSize: 'placeholder-value',
|
|
23432
25629
|
* // The standard list page token.
|
|
23433
25630
|
* pageToken: 'placeholder-value',
|
|
25631
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
25632
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
23434
25633
|
* },
|
|
23435
25634
|
* );
|
|
23436
25635
|
* console.log(res.data);
|
|
@@ -23438,7 +25637,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
23438
25637
|
* // Example response
|
|
23439
25638
|
* // {
|
|
23440
25639
|
* // "nextPageToken": "my_nextPageToken",
|
|
23441
|
-
* // "operations": []
|
|
25640
|
+
* // "operations": [],
|
|
25641
|
+
* // "unreachable": []
|
|
23442
25642
|
* // }
|
|
23443
25643
|
* }
|
|
23444
25644
|
*
|
|
@@ -23494,6 +25694,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
23494
25694
|
* The standard list page token.
|
|
23495
25695
|
*/
|
|
23496
25696
|
pageToken?: string;
|
|
25697
|
+
/**
|
|
25698
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
25699
|
+
*/
|
|
25700
|
+
returnPartialSuccess?: boolean;
|
|
23497
25701
|
}
|
|
23498
25702
|
export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
|
|
23499
25703
|
context: APIRequestContext;
|
|
@@ -23825,6 +26029,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
23825
26029
|
* // "filter": "my_filter",
|
|
23826
26030
|
* // "imageQuery": {},
|
|
23827
26031
|
* // "languageCode": "my_languageCode",
|
|
26032
|
+
* // "naturalLanguageQueryUnderstandingSpec": {},
|
|
23828
26033
|
* // "offset": 0,
|
|
23829
26034
|
* // "oneBoxPageSize": 0,
|
|
23830
26035
|
* // "orderBy": "my_orderBy",
|
|
@@ -23936,6 +26141,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
23936
26141
|
* // "filter": "my_filter",
|
|
23937
26142
|
* // "imageQuery": {},
|
|
23938
26143
|
* // "languageCode": "my_languageCode",
|
|
26144
|
+
* // "naturalLanguageQueryUnderstandingSpec": {},
|
|
23939
26145
|
* // "offset": 0,
|
|
23940
26146
|
* // "oneBoxPageSize": 0,
|
|
23941
26147
|
* // "orderBy": "my_orderBy",
|
|
@@ -24782,13 +26988,16 @@ export declare namespace discoveryengine_v1 {
|
|
|
24782
26988
|
* pageSize: 'placeholder-value',
|
|
24783
26989
|
* // The standard list page token.
|
|
24784
26990
|
* pageToken: 'placeholder-value',
|
|
26991
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
26992
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
24785
26993
|
* });
|
|
24786
26994
|
* console.log(res.data);
|
|
24787
26995
|
*
|
|
24788
26996
|
* // Example response
|
|
24789
26997
|
* // {
|
|
24790
26998
|
* // "nextPageToken": "my_nextPageToken",
|
|
24791
|
-
* // "operations": []
|
|
26999
|
+
* // "operations": [],
|
|
27000
|
+
* // "unreachable": []
|
|
24792
27001
|
* // }
|
|
24793
27002
|
* }
|
|
24794
27003
|
*
|
|
@@ -24834,6 +27043,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
24834
27043
|
* The standard list page token.
|
|
24835
27044
|
*/
|
|
24836
27045
|
pageToken?: string;
|
|
27046
|
+
/**
|
|
27047
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
27048
|
+
*/
|
|
27049
|
+
returnPartialSuccess?: boolean;
|
|
24837
27050
|
}
|
|
24838
27051
|
export class Resource$Projects$Locations$Datastores {
|
|
24839
27052
|
context: APIRequestContext;
|
|
@@ -24975,6 +27188,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24975
27188
|
* // "advancedSiteSearchConfig": {},
|
|
24976
27189
|
* // "billingEstimation": {},
|
|
24977
27190
|
* // "cmekConfig": {},
|
|
27191
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
24978
27192
|
* // "contentConfig": "my_contentConfig",
|
|
24979
27193
|
* // "createTime": "my_createTime",
|
|
24980
27194
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -25129,6 +27343,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
25129
27343
|
* // "advancedSiteSearchConfig": {},
|
|
25130
27344
|
* // "billingEstimation": {},
|
|
25131
27345
|
* // "cmekConfig": {},
|
|
27346
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
25132
27347
|
* // "contentConfig": "my_contentConfig",
|
|
25133
27348
|
* // "createTime": "my_createTime",
|
|
25134
27349
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -25337,6 +27552,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
25337
27552
|
* // "advancedSiteSearchConfig": {},
|
|
25338
27553
|
* // "billingEstimation": {},
|
|
25339
27554
|
* // "cmekConfig": {},
|
|
27555
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
25340
27556
|
* // "contentConfig": "my_contentConfig",
|
|
25341
27557
|
* // "createTime": "my_createTime",
|
|
25342
27558
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -25363,6 +27579,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
25363
27579
|
* // "advancedSiteSearchConfig": {},
|
|
25364
27580
|
* // "billingEstimation": {},
|
|
25365
27581
|
* // "cmekConfig": {},
|
|
27582
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
25366
27583
|
* // "contentConfig": "my_contentConfig",
|
|
25367
27584
|
* // "createTime": "my_createTime",
|
|
25368
27585
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -26410,6 +28627,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
26410
28627
|
* pageSize: 'placeholder-value',
|
|
26411
28628
|
* // The standard list page token.
|
|
26412
28629
|
* pageToken: 'placeholder-value',
|
|
28630
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
28631
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
26413
28632
|
* },
|
|
26414
28633
|
* );
|
|
26415
28634
|
* console.log(res.data);
|
|
@@ -26417,7 +28636,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
26417
28636
|
* // Example response
|
|
26418
28637
|
* // {
|
|
26419
28638
|
* // "nextPageToken": "my_nextPageToken",
|
|
26420
|
-
* // "operations": []
|
|
28639
|
+
* // "operations": [],
|
|
28640
|
+
* // "unreachable": []
|
|
26421
28641
|
* // }
|
|
26422
28642
|
* }
|
|
26423
28643
|
*
|
|
@@ -26473,6 +28693,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
26473
28693
|
* The standard list page token.
|
|
26474
28694
|
*/
|
|
26475
28695
|
pageToken?: string;
|
|
28696
|
+
/**
|
|
28697
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
28698
|
+
*/
|
|
28699
|
+
returnPartialSuccess?: boolean;
|
|
26476
28700
|
}
|
|
26477
28701
|
export class Resource$Projects$Locations$Datastores$Completionconfig {
|
|
26478
28702
|
context: APIRequestContext;
|
|
@@ -27816,13 +30040,16 @@ export declare namespace discoveryengine_v1 {
|
|
|
27816
30040
|
* pageSize: 'placeholder-value',
|
|
27817
30041
|
* // The standard list page token.
|
|
27818
30042
|
* pageToken: 'placeholder-value',
|
|
30043
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
30044
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
27819
30045
|
* });
|
|
27820
30046
|
* console.log(res.data);
|
|
27821
30047
|
*
|
|
27822
30048
|
* // Example response
|
|
27823
30049
|
* // {
|
|
27824
30050
|
* // "nextPageToken": "my_nextPageToken",
|
|
27825
|
-
* // "operations": []
|
|
30051
|
+
* // "operations": [],
|
|
30052
|
+
* // "unreachable": []
|
|
27826
30053
|
* // }
|
|
27827
30054
|
* }
|
|
27828
30055
|
*
|
|
@@ -27868,6 +30095,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
27868
30095
|
* The standard list page token.
|
|
27869
30096
|
*/
|
|
27870
30097
|
pageToken?: string;
|
|
30098
|
+
/**
|
|
30099
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
30100
|
+
*/
|
|
30101
|
+
returnPartialSuccess?: boolean;
|
|
27871
30102
|
}
|
|
27872
30103
|
export class Resource$Projects$Locations$Datastores$Operations {
|
|
27873
30104
|
context: APIRequestContext;
|
|
@@ -27977,13 +30208,16 @@ export declare namespace discoveryengine_v1 {
|
|
|
27977
30208
|
* pageSize: 'placeholder-value',
|
|
27978
30209
|
* // The standard list page token.
|
|
27979
30210
|
* pageToken: 'placeholder-value',
|
|
30211
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
30212
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
27980
30213
|
* });
|
|
27981
30214
|
* console.log(res.data);
|
|
27982
30215
|
*
|
|
27983
30216
|
* // Example response
|
|
27984
30217
|
* // {
|
|
27985
30218
|
* // "nextPageToken": "my_nextPageToken",
|
|
27986
|
-
* // "operations": []
|
|
30219
|
+
* // "operations": [],
|
|
30220
|
+
* // "unreachable": []
|
|
27987
30221
|
* // }
|
|
27988
30222
|
* }
|
|
27989
30223
|
*
|
|
@@ -28029,6 +30263,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
28029
30263
|
* The standard list page token.
|
|
28030
30264
|
*/
|
|
28031
30265
|
pageToken?: string;
|
|
30266
|
+
/**
|
|
30267
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
30268
|
+
*/
|
|
30269
|
+
returnPartialSuccess?: boolean;
|
|
28032
30270
|
}
|
|
28033
30271
|
export class Resource$Projects$Locations$Datastores$Schemas {
|
|
28034
30272
|
context: APIRequestContext;
|
|
@@ -28761,6 +30999,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
28761
30999
|
* // "filter": "my_filter",
|
|
28762
31000
|
* // "imageQuery": {},
|
|
28763
31001
|
* // "languageCode": "my_languageCode",
|
|
31002
|
+
* // "naturalLanguageQueryUnderstandingSpec": {},
|
|
28764
31003
|
* // "offset": 0,
|
|
28765
31004
|
* // "oneBoxPageSize": 0,
|
|
28766
31005
|
* // "orderBy": "my_orderBy",
|
|
@@ -28871,6 +31110,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
28871
31110
|
* // "filter": "my_filter",
|
|
28872
31111
|
* // "imageQuery": {},
|
|
28873
31112
|
* // "languageCode": "my_languageCode",
|
|
31113
|
+
* // "naturalLanguageQueryUnderstandingSpec": {},
|
|
28874
31114
|
* // "offset": 0,
|
|
28875
31115
|
* // "oneBoxPageSize": 0,
|
|
28876
31116
|
* // "orderBy": "my_orderBy",
|
|
@@ -31656,23 +33896,327 @@ export declare namespace discoveryengine_v1 {
|
|
|
31656
33896
|
*
|
|
31657
33897
|
* // Do the magic
|
|
31658
33898
|
* const res =
|
|
31659
|
-
* await discoveryengine.projects.locations.identityMappingStores.listIdentityMappings(
|
|
33899
|
+
* await discoveryengine.projects.locations.identityMappingStores.listIdentityMappings(
|
|
33900
|
+
* {
|
|
33901
|
+
* // Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}`
|
|
33902
|
+
* identityMappingStore:
|
|
33903
|
+
* 'projects/my-project/locations/my-location/identityMappingStores/my-identityMappingStore',
|
|
33904
|
+
* // Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000.
|
|
33905
|
+
* pageSize: 'placeholder-value',
|
|
33906
|
+
* // A page token, received from a previous `ListIdentityMappings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappings` must match the call that provided the page token.
|
|
33907
|
+
* pageToken: 'placeholder-value',
|
|
33908
|
+
* },
|
|
33909
|
+
* );
|
|
33910
|
+
* console.log(res.data);
|
|
33911
|
+
*
|
|
33912
|
+
* // Example response
|
|
33913
|
+
* // {
|
|
33914
|
+
* // "identityMappingEntries": [],
|
|
33915
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
33916
|
+
* // }
|
|
33917
|
+
* }
|
|
33918
|
+
*
|
|
33919
|
+
* main().catch(e => {
|
|
33920
|
+
* console.error(e);
|
|
33921
|
+
* throw e;
|
|
33922
|
+
* });
|
|
33923
|
+
*
|
|
33924
|
+
* ```
|
|
33925
|
+
*
|
|
33926
|
+
* @param params - Parameters for request
|
|
33927
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
33928
|
+
* @param callback - Optional callback that handles the response.
|
|
33929
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
33930
|
+
*/
|
|
33931
|
+
listIdentityMappings(params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
33932
|
+
listIdentityMappings(params?: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse>>;
|
|
33933
|
+
listIdentityMappings(params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
33934
|
+
listIdentityMappings(params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse>): void;
|
|
33935
|
+
listIdentityMappings(params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse>): void;
|
|
33936
|
+
listIdentityMappings(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse>): void;
|
|
33937
|
+
/**
|
|
33938
|
+
* Purges specified or all Identity Mapping Entries from an Identity Mapping Store.
|
|
33939
|
+
* @example
|
|
33940
|
+
* ```js
|
|
33941
|
+
* // Before running the sample:
|
|
33942
|
+
* // - Enable the API at:
|
|
33943
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
33944
|
+
* // - Login into gcloud by running:
|
|
33945
|
+
* // ```sh
|
|
33946
|
+
* // $ gcloud auth application-default login
|
|
33947
|
+
* // ```
|
|
33948
|
+
* // - Install the npm module by running:
|
|
33949
|
+
* // ```sh
|
|
33950
|
+
* // $ npm install googleapis
|
|
33951
|
+
* // ```
|
|
33952
|
+
*
|
|
33953
|
+
* const {google} = require('googleapis');
|
|
33954
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
33955
|
+
*
|
|
33956
|
+
* async function main() {
|
|
33957
|
+
* const auth = new google.auth.GoogleAuth({
|
|
33958
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
33959
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
33960
|
+
* });
|
|
33961
|
+
*
|
|
33962
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
33963
|
+
* const authClient = await auth.getClient();
|
|
33964
|
+
* google.options({auth: authClient});
|
|
33965
|
+
*
|
|
33966
|
+
* // Do the magic
|
|
33967
|
+
* const res =
|
|
33968
|
+
* await discoveryengine.projects.locations.identityMappingStores.purgeIdentityMappings(
|
|
33969
|
+
* {
|
|
33970
|
+
* // Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}`
|
|
33971
|
+
* identityMappingStore:
|
|
33972
|
+
* 'projects/my-project/locations/my-location/identityMappingStores/my-identityMappingStore',
|
|
33973
|
+
*
|
|
33974
|
+
* // Request body metadata
|
|
33975
|
+
* requestBody: {
|
|
33976
|
+
* // request body parameters
|
|
33977
|
+
* // {
|
|
33978
|
+
* // "filter": "my_filter",
|
|
33979
|
+
* // "force": false,
|
|
33980
|
+
* // "inlineSource": {}
|
|
33981
|
+
* // }
|
|
33982
|
+
* },
|
|
33983
|
+
* },
|
|
33984
|
+
* );
|
|
33985
|
+
* console.log(res.data);
|
|
33986
|
+
*
|
|
33987
|
+
* // Example response
|
|
33988
|
+
* // {
|
|
33989
|
+
* // "done": false,
|
|
33990
|
+
* // "error": {},
|
|
33991
|
+
* // "metadata": {},
|
|
33992
|
+
* // "name": "my_name",
|
|
33993
|
+
* // "response": {}
|
|
33994
|
+
* // }
|
|
33995
|
+
* }
|
|
33996
|
+
*
|
|
33997
|
+
* main().catch(e => {
|
|
33998
|
+
* console.error(e);
|
|
33999
|
+
* throw e;
|
|
34000
|
+
* });
|
|
34001
|
+
*
|
|
34002
|
+
* ```
|
|
34003
|
+
*
|
|
34004
|
+
* @param params - Parameters for request
|
|
34005
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
34006
|
+
* @param callback - Optional callback that handles the response.
|
|
34007
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
34008
|
+
*/
|
|
34009
|
+
purgeIdentityMappings(params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
34010
|
+
purgeIdentityMappings(params?: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
34011
|
+
purgeIdentityMappings(params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
34012
|
+
purgeIdentityMappings(params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
34013
|
+
purgeIdentityMappings(params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
34014
|
+
purgeIdentityMappings(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
34015
|
+
}
|
|
34016
|
+
export interface Params$Resource$Projects$Locations$Identitymappingstores$Create extends StandardParameters {
|
|
34017
|
+
/**
|
|
34018
|
+
* Resource name of the CmekConfig to use for protecting this Identity Mapping Store.
|
|
34019
|
+
*/
|
|
34020
|
+
cmekConfigName?: string;
|
|
34021
|
+
/**
|
|
34022
|
+
* Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.
|
|
34023
|
+
*/
|
|
34024
|
+
disableCmek?: boolean;
|
|
34025
|
+
/**
|
|
34026
|
+
* Required. The ID of the Identity Mapping Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.
|
|
34027
|
+
*/
|
|
34028
|
+
identityMappingStoreId?: string;
|
|
34029
|
+
/**
|
|
34030
|
+
* Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`.
|
|
34031
|
+
*/
|
|
34032
|
+
parent?: string;
|
|
34033
|
+
/**
|
|
34034
|
+
* Request body metadata
|
|
34035
|
+
*/
|
|
34036
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1IdentityMappingStore;
|
|
34037
|
+
}
|
|
34038
|
+
export interface Params$Resource$Projects$Locations$Identitymappingstores$Delete extends StandardParameters {
|
|
34039
|
+
/**
|
|
34040
|
+
* Required. The name of the Identity Mapping Store to delete. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}`
|
|
34041
|
+
*/
|
|
34042
|
+
name?: string;
|
|
34043
|
+
}
|
|
34044
|
+
export interface Params$Resource$Projects$Locations$Identitymappingstores$Get extends StandardParameters {
|
|
34045
|
+
/**
|
|
34046
|
+
* Required. The name of the Identity Mapping Store to get. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}`
|
|
34047
|
+
*/
|
|
34048
|
+
name?: string;
|
|
34049
|
+
}
|
|
34050
|
+
export interface Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings extends StandardParameters {
|
|
34051
|
+
/**
|
|
34052
|
+
* Required. The name of the Identity Mapping Store to import Identity Mapping Entries to. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}`
|
|
34053
|
+
*/
|
|
34054
|
+
identityMappingStore?: string;
|
|
34055
|
+
/**
|
|
34056
|
+
* Request body metadata
|
|
34057
|
+
*/
|
|
34058
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest;
|
|
34059
|
+
}
|
|
34060
|
+
export interface Params$Resource$Projects$Locations$Identitymappingstores$List extends StandardParameters {
|
|
34061
|
+
/**
|
|
34062
|
+
* Maximum number of IdentityMappingStores to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.
|
|
34063
|
+
*/
|
|
34064
|
+
pageSize?: number;
|
|
34065
|
+
/**
|
|
34066
|
+
* A page token, received from a previous `ListIdentityMappingStores` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappingStores` must match the call that provided the page token.
|
|
34067
|
+
*/
|
|
34068
|
+
pageToken?: string;
|
|
34069
|
+
/**
|
|
34070
|
+
* Required. The parent of the Identity Mapping Stores to list. Format: `projects/{project\}/locations/{location\}`.
|
|
34071
|
+
*/
|
|
34072
|
+
parent?: string;
|
|
34073
|
+
}
|
|
34074
|
+
export interface Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings extends StandardParameters {
|
|
34075
|
+
/**
|
|
34076
|
+
* Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}`
|
|
34077
|
+
*/
|
|
34078
|
+
identityMappingStore?: string;
|
|
34079
|
+
/**
|
|
34080
|
+
* Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000.
|
|
34081
|
+
*/
|
|
34082
|
+
pageSize?: number;
|
|
34083
|
+
/**
|
|
34084
|
+
* A page token, received from a previous `ListIdentityMappings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappings` must match the call that provided the page token.
|
|
34085
|
+
*/
|
|
34086
|
+
pageToken?: string;
|
|
34087
|
+
}
|
|
34088
|
+
export interface Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings extends StandardParameters {
|
|
34089
|
+
/**
|
|
34090
|
+
* Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}`
|
|
34091
|
+
*/
|
|
34092
|
+
identityMappingStore?: string;
|
|
34093
|
+
/**
|
|
34094
|
+
* Request body metadata
|
|
34095
|
+
*/
|
|
34096
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest;
|
|
34097
|
+
}
|
|
34098
|
+
export class Resource$Projects$Locations$Identitymappingstores$Operations {
|
|
34099
|
+
context: APIRequestContext;
|
|
34100
|
+
constructor(context: APIRequestContext);
|
|
34101
|
+
/**
|
|
34102
|
+
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
|
34103
|
+
* @example
|
|
34104
|
+
* ```js
|
|
34105
|
+
* // Before running the sample:
|
|
34106
|
+
* // - Enable the API at:
|
|
34107
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
34108
|
+
* // - Login into gcloud by running:
|
|
34109
|
+
* // ```sh
|
|
34110
|
+
* // $ gcloud auth application-default login
|
|
34111
|
+
* // ```
|
|
34112
|
+
* // - Install the npm module by running:
|
|
34113
|
+
* // ```sh
|
|
34114
|
+
* // $ npm install googleapis
|
|
34115
|
+
* // ```
|
|
34116
|
+
*
|
|
34117
|
+
* const {google} = require('googleapis');
|
|
34118
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
34119
|
+
*
|
|
34120
|
+
* async function main() {
|
|
34121
|
+
* const auth = new google.auth.GoogleAuth({
|
|
34122
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
34123
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
34124
|
+
* });
|
|
34125
|
+
*
|
|
34126
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
34127
|
+
* const authClient = await auth.getClient();
|
|
34128
|
+
* google.options({auth: authClient});
|
|
34129
|
+
*
|
|
34130
|
+
* // Do the magic
|
|
34131
|
+
* const res =
|
|
34132
|
+
* await discoveryengine.projects.locations.identityMappingStores.operations.get(
|
|
34133
|
+
* {
|
|
34134
|
+
* // The name of the operation resource.
|
|
34135
|
+
* name: 'projects/my-project/locations/my-location/identityMappingStores/my-identityMappingStore/operations/my-operation',
|
|
34136
|
+
* },
|
|
34137
|
+
* );
|
|
34138
|
+
* console.log(res.data);
|
|
34139
|
+
*
|
|
34140
|
+
* // Example response
|
|
34141
|
+
* // {
|
|
34142
|
+
* // "done": false,
|
|
34143
|
+
* // "error": {},
|
|
34144
|
+
* // "metadata": {},
|
|
34145
|
+
* // "name": "my_name",
|
|
34146
|
+
* // "response": {}
|
|
34147
|
+
* // }
|
|
34148
|
+
* }
|
|
34149
|
+
*
|
|
34150
|
+
* main().catch(e => {
|
|
34151
|
+
* console.error(e);
|
|
34152
|
+
* throw e;
|
|
34153
|
+
* });
|
|
34154
|
+
*
|
|
34155
|
+
* ```
|
|
34156
|
+
*
|
|
34157
|
+
* @param params - Parameters for request
|
|
34158
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
34159
|
+
* @param callback - Optional callback that handles the response.
|
|
34160
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
34161
|
+
*/
|
|
34162
|
+
get(params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
34163
|
+
get(params?: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
34164
|
+
get(params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
34165
|
+
get(params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
34166
|
+
get(params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
34167
|
+
get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
34168
|
+
/**
|
|
34169
|
+
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
34170
|
+
* @example
|
|
34171
|
+
* ```js
|
|
34172
|
+
* // Before running the sample:
|
|
34173
|
+
* // - Enable the API at:
|
|
34174
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
34175
|
+
* // - Login into gcloud by running:
|
|
34176
|
+
* // ```sh
|
|
34177
|
+
* // $ gcloud auth application-default login
|
|
34178
|
+
* // ```
|
|
34179
|
+
* // - Install the npm module by running:
|
|
34180
|
+
* // ```sh
|
|
34181
|
+
* // $ npm install googleapis
|
|
34182
|
+
* // ```
|
|
34183
|
+
*
|
|
34184
|
+
* const {google} = require('googleapis');
|
|
34185
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
34186
|
+
*
|
|
34187
|
+
* async function main() {
|
|
34188
|
+
* const auth = new google.auth.GoogleAuth({
|
|
34189
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
34190
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
34191
|
+
* });
|
|
34192
|
+
*
|
|
34193
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
34194
|
+
* const authClient = await auth.getClient();
|
|
34195
|
+
* google.options({auth: authClient});
|
|
34196
|
+
*
|
|
34197
|
+
* // Do the magic
|
|
34198
|
+
* const res =
|
|
34199
|
+
* await discoveryengine.projects.locations.identityMappingStores.operations.list(
|
|
31660
34200
|
* {
|
|
31661
|
-
* //
|
|
31662
|
-
*
|
|
31663
|
-
*
|
|
31664
|
-
*
|
|
34201
|
+
* // The standard list filter.
|
|
34202
|
+
* filter: 'placeholder-value',
|
|
34203
|
+
* // The name of the operation's parent resource.
|
|
34204
|
+
* name: 'projects/my-project/locations/my-location/identityMappingStores/my-identityMappingStore',
|
|
34205
|
+
* // The standard list page size.
|
|
31665
34206
|
* pageSize: 'placeholder-value',
|
|
31666
|
-
* //
|
|
34207
|
+
* // The standard list page token.
|
|
31667
34208
|
* pageToken: 'placeholder-value',
|
|
34209
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
34210
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
31668
34211
|
* },
|
|
31669
34212
|
* );
|
|
31670
34213
|
* console.log(res.data);
|
|
31671
34214
|
*
|
|
31672
34215
|
* // Example response
|
|
31673
34216
|
* // {
|
|
31674
|
-
* // "
|
|
31675
|
-
* // "
|
|
34217
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
34218
|
+
* // "operations": [],
|
|
34219
|
+
* // "unreachable": []
|
|
31676
34220
|
* // }
|
|
31677
34221
|
* }
|
|
31678
34222
|
*
|
|
@@ -31688,14 +34232,46 @@ export declare namespace discoveryengine_v1 {
|
|
|
31688
34232
|
* @param callback - Optional callback that handles the response.
|
|
31689
34233
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
31690
34234
|
*/
|
|
31691
|
-
|
|
31692
|
-
|
|
31693
|
-
|
|
31694
|
-
|
|
31695
|
-
|
|
31696
|
-
|
|
34235
|
+
list(params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
34236
|
+
list(params?: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningListOperationsResponse>>;
|
|
34237
|
+
list(params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
34238
|
+
list(params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>, callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
|
|
34239
|
+
list(params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
|
|
34240
|
+
list(callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
|
|
34241
|
+
}
|
|
34242
|
+
export interface Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get extends StandardParameters {
|
|
31697
34243
|
/**
|
|
31698
|
-
*
|
|
34244
|
+
* The name of the operation resource.
|
|
34245
|
+
*/
|
|
34246
|
+
name?: string;
|
|
34247
|
+
}
|
|
34248
|
+
export interface Params$Resource$Projects$Locations$Identitymappingstores$Operations$List extends StandardParameters {
|
|
34249
|
+
/**
|
|
34250
|
+
* The standard list filter.
|
|
34251
|
+
*/
|
|
34252
|
+
filter?: string;
|
|
34253
|
+
/**
|
|
34254
|
+
* The name of the operation's parent resource.
|
|
34255
|
+
*/
|
|
34256
|
+
name?: string;
|
|
34257
|
+
/**
|
|
34258
|
+
* The standard list page size.
|
|
34259
|
+
*/
|
|
34260
|
+
pageSize?: number;
|
|
34261
|
+
/**
|
|
34262
|
+
* The standard list page token.
|
|
34263
|
+
*/
|
|
34264
|
+
pageToken?: string;
|
|
34265
|
+
/**
|
|
34266
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
34267
|
+
*/
|
|
34268
|
+
returnPartialSuccess?: boolean;
|
|
34269
|
+
}
|
|
34270
|
+
export class Resource$Projects$Locations$Licenseconfigs {
|
|
34271
|
+
context: APIRequestContext;
|
|
34272
|
+
constructor(context: APIRequestContext);
|
|
34273
|
+
/**
|
|
34274
|
+
* Creates a LicenseConfig
|
|
31699
34275
|
* @example
|
|
31700
34276
|
* ```js
|
|
31701
34277
|
* // Before running the sample:
|
|
@@ -31724,33 +34300,43 @@ export declare namespace discoveryengine_v1 {
|
|
|
31724
34300
|
* google.options({auth: authClient});
|
|
31725
34301
|
*
|
|
31726
34302
|
* // Do the magic
|
|
31727
|
-
* const res =
|
|
31728
|
-
*
|
|
31729
|
-
*
|
|
31730
|
-
*
|
|
31731
|
-
*
|
|
31732
|
-
* 'projects/my-project/locations/my-location/identityMappingStores/my-identityMappingStore',
|
|
34303
|
+
* const res = await discoveryengine.projects.locations.licenseConfigs.create({
|
|
34304
|
+
* // Optional. The ID to use for the LicenseConfig, which will become the final component of the LicenseConfig's resource name. We are using the tier (product edition) name as the license config id such as `search` or `search_and_assistant`.
|
|
34305
|
+
* licenseConfigId: 'placeholder-value',
|
|
34306
|
+
* // Required. The parent resource name, such as `projects/{project\}/locations/{location\}`.
|
|
34307
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
31733
34308
|
*
|
|
31734
|
-
*
|
|
31735
|
-
*
|
|
31736
|
-
*
|
|
31737
|
-
*
|
|
31738
|
-
*
|
|
31739
|
-
*
|
|
31740
|
-
*
|
|
31741
|
-
*
|
|
31742
|
-
*
|
|
31743
|
-
*
|
|
31744
|
-
*
|
|
34309
|
+
* // Request body metadata
|
|
34310
|
+
* requestBody: {
|
|
34311
|
+
* // request body parameters
|
|
34312
|
+
* // {
|
|
34313
|
+
* // "alertPolicyResourceConfig": {},
|
|
34314
|
+
* // "autoRenew": false,
|
|
34315
|
+
* // "endDate": {},
|
|
34316
|
+
* // "freeTrial": false,
|
|
34317
|
+
* // "licenseCount": "my_licenseCount",
|
|
34318
|
+
* // "name": "my_name",
|
|
34319
|
+
* // "startDate": {},
|
|
34320
|
+
* // "state": "my_state",
|
|
34321
|
+
* // "subscriptionTerm": "my_subscriptionTerm",
|
|
34322
|
+
* // "subscriptionTier": "my_subscriptionTier"
|
|
34323
|
+
* // }
|
|
34324
|
+
* },
|
|
34325
|
+
* });
|
|
31745
34326
|
* console.log(res.data);
|
|
31746
34327
|
*
|
|
31747
34328
|
* // Example response
|
|
31748
34329
|
* // {
|
|
31749
|
-
* // "
|
|
31750
|
-
* // "
|
|
31751
|
-
* // "
|
|
34330
|
+
* // "alertPolicyResourceConfig": {},
|
|
34331
|
+
* // "autoRenew": false,
|
|
34332
|
+
* // "endDate": {},
|
|
34333
|
+
* // "freeTrial": false,
|
|
34334
|
+
* // "licenseCount": "my_licenseCount",
|
|
31752
34335
|
* // "name": "my_name",
|
|
31753
|
-
* // "
|
|
34336
|
+
* // "startDate": {},
|
|
34337
|
+
* // "state": "my_state",
|
|
34338
|
+
* // "subscriptionTerm": "my_subscriptionTerm",
|
|
34339
|
+
* // "subscriptionTier": "my_subscriptionTier"
|
|
31754
34340
|
* // }
|
|
31755
34341
|
* }
|
|
31756
34342
|
*
|
|
@@ -31766,100 +34352,14 @@ export declare namespace discoveryengine_v1 {
|
|
|
31766
34352
|
* @param callback - Optional callback that handles the response.
|
|
31767
34353
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
31768
34354
|
*/
|
|
31769
|
-
|
|
31770
|
-
|
|
31771
|
-
|
|
31772
|
-
|
|
31773
|
-
|
|
31774
|
-
|
|
31775
|
-
}
|
|
31776
|
-
export interface Params$Resource$Projects$Locations$Identitymappingstores$Create extends StandardParameters {
|
|
34355
|
+
create(params: Params$Resource$Projects$Locations$Licenseconfigs$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
34356
|
+
create(params?: Params$Resource$Projects$Locations$Licenseconfigs$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1LicenseConfig>>;
|
|
34357
|
+
create(params: Params$Resource$Projects$Locations$Licenseconfigs$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
34358
|
+
create(params: Params$Resource$Projects$Locations$Licenseconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1LicenseConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1LicenseConfig>): void;
|
|
34359
|
+
create(params: Params$Resource$Projects$Locations$Licenseconfigs$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1LicenseConfig>): void;
|
|
34360
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1LicenseConfig>): void;
|
|
31777
34361
|
/**
|
|
31778
|
-
*
|
|
31779
|
-
*/
|
|
31780
|
-
cmekConfigName?: string;
|
|
31781
|
-
/**
|
|
31782
|
-
* Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.
|
|
31783
|
-
*/
|
|
31784
|
-
disableCmek?: boolean;
|
|
31785
|
-
/**
|
|
31786
|
-
* Required. The ID of the Identity Mapping Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.
|
|
31787
|
-
*/
|
|
31788
|
-
identityMappingStoreId?: string;
|
|
31789
|
-
/**
|
|
31790
|
-
* Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`.
|
|
31791
|
-
*/
|
|
31792
|
-
parent?: string;
|
|
31793
|
-
/**
|
|
31794
|
-
* Request body metadata
|
|
31795
|
-
*/
|
|
31796
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1IdentityMappingStore;
|
|
31797
|
-
}
|
|
31798
|
-
export interface Params$Resource$Projects$Locations$Identitymappingstores$Delete extends StandardParameters {
|
|
31799
|
-
/**
|
|
31800
|
-
* Required. The name of the Identity Mapping Store to delete. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}`
|
|
31801
|
-
*/
|
|
31802
|
-
name?: string;
|
|
31803
|
-
}
|
|
31804
|
-
export interface Params$Resource$Projects$Locations$Identitymappingstores$Get extends StandardParameters {
|
|
31805
|
-
/**
|
|
31806
|
-
* Required. The name of the Identity Mapping Store to get. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}`
|
|
31807
|
-
*/
|
|
31808
|
-
name?: string;
|
|
31809
|
-
}
|
|
31810
|
-
export interface Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings extends StandardParameters {
|
|
31811
|
-
/**
|
|
31812
|
-
* Required. The name of the Identity Mapping Store to import Identity Mapping Entries to. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}`
|
|
31813
|
-
*/
|
|
31814
|
-
identityMappingStore?: string;
|
|
31815
|
-
/**
|
|
31816
|
-
* Request body metadata
|
|
31817
|
-
*/
|
|
31818
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest;
|
|
31819
|
-
}
|
|
31820
|
-
export interface Params$Resource$Projects$Locations$Identitymappingstores$List extends StandardParameters {
|
|
31821
|
-
/**
|
|
31822
|
-
* Maximum number of IdentityMappingStores to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.
|
|
31823
|
-
*/
|
|
31824
|
-
pageSize?: number;
|
|
31825
|
-
/**
|
|
31826
|
-
* A page token, received from a previous `ListIdentityMappingStores` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappingStores` must match the call that provided the page token.
|
|
31827
|
-
*/
|
|
31828
|
-
pageToken?: string;
|
|
31829
|
-
/**
|
|
31830
|
-
* Required. The parent of the Identity Mapping Stores to list. Format: `projects/{project\}/locations/{location\}`.
|
|
31831
|
-
*/
|
|
31832
|
-
parent?: string;
|
|
31833
|
-
}
|
|
31834
|
-
export interface Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings extends StandardParameters {
|
|
31835
|
-
/**
|
|
31836
|
-
* Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}`
|
|
31837
|
-
*/
|
|
31838
|
-
identityMappingStore?: string;
|
|
31839
|
-
/**
|
|
31840
|
-
* Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000.
|
|
31841
|
-
*/
|
|
31842
|
-
pageSize?: number;
|
|
31843
|
-
/**
|
|
31844
|
-
* A page token, received from a previous `ListIdentityMappings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappings` must match the call that provided the page token.
|
|
31845
|
-
*/
|
|
31846
|
-
pageToken?: string;
|
|
31847
|
-
}
|
|
31848
|
-
export interface Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings extends StandardParameters {
|
|
31849
|
-
/**
|
|
31850
|
-
* Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}`
|
|
31851
|
-
*/
|
|
31852
|
-
identityMappingStore?: string;
|
|
31853
|
-
/**
|
|
31854
|
-
* Request body metadata
|
|
31855
|
-
*/
|
|
31856
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest;
|
|
31857
|
-
}
|
|
31858
|
-
export class Resource$Projects$Locations$Identitymappingstores$Operations {
|
|
31859
|
-
context: APIRequestContext;
|
|
31860
|
-
constructor(context: APIRequestContext);
|
|
31861
|
-
/**
|
|
31862
|
-
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
|
34362
|
+
* Gets a LicenseConfig.
|
|
31863
34363
|
* @example
|
|
31864
34364
|
* ```js
|
|
31865
34365
|
* // Before running the sample:
|
|
@@ -31888,22 +34388,24 @@ export declare namespace discoveryengine_v1 {
|
|
|
31888
34388
|
* google.options({auth: authClient});
|
|
31889
34389
|
*
|
|
31890
34390
|
* // Do the magic
|
|
31891
|
-
* const res =
|
|
31892
|
-
*
|
|
31893
|
-
*
|
|
31894
|
-
*
|
|
31895
|
-
* name: 'projects/my-project/locations/my-location/identityMappingStores/my-identityMappingStore/operations/my-operation',
|
|
31896
|
-
* },
|
|
31897
|
-
* );
|
|
34391
|
+
* const res = await discoveryengine.projects.locations.licenseConfigs.get({
|
|
34392
|
+
* // Required. Full resource name of LicenseConfig, such as `projects/{project\}/locations/{location\}/licenseConfigs/x`. If the caller does not have permission to access the LicenseConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested LicenseConfig does not exist, a NOT_FOUND error is returned.
|
|
34393
|
+
* name: 'projects/my-project/locations/my-location/licenseConfigs/my-licenseConfig',
|
|
34394
|
+
* });
|
|
31898
34395
|
* console.log(res.data);
|
|
31899
34396
|
*
|
|
31900
34397
|
* // Example response
|
|
31901
34398
|
* // {
|
|
31902
|
-
* // "
|
|
31903
|
-
* // "
|
|
31904
|
-
* // "
|
|
34399
|
+
* // "alertPolicyResourceConfig": {},
|
|
34400
|
+
* // "autoRenew": false,
|
|
34401
|
+
* // "endDate": {},
|
|
34402
|
+
* // "freeTrial": false,
|
|
34403
|
+
* // "licenseCount": "my_licenseCount",
|
|
31905
34404
|
* // "name": "my_name",
|
|
31906
|
-
* // "
|
|
34405
|
+
* // "startDate": {},
|
|
34406
|
+
* // "state": "my_state",
|
|
34407
|
+
* // "subscriptionTerm": "my_subscriptionTerm",
|
|
34408
|
+
* // "subscriptionTier": "my_subscriptionTier"
|
|
31907
34409
|
* // }
|
|
31908
34410
|
* }
|
|
31909
34411
|
*
|
|
@@ -31919,14 +34421,14 @@ export declare namespace discoveryengine_v1 {
|
|
|
31919
34421
|
* @param callback - Optional callback that handles the response.
|
|
31920
34422
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
31921
34423
|
*/
|
|
31922
|
-
get(params: Params$Resource$Projects$Locations$
|
|
31923
|
-
get(params?: Params$Resource$Projects$Locations$
|
|
31924
|
-
get(params: Params$Resource$Projects$Locations$
|
|
31925
|
-
get(params: Params$Resource$Projects$Locations$
|
|
31926
|
-
get(params: Params$Resource$Projects$Locations$
|
|
31927
|
-
get(callback: BodyResponseCallback<Schema$
|
|
34424
|
+
get(params: Params$Resource$Projects$Locations$Licenseconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
34425
|
+
get(params?: Params$Resource$Projects$Locations$Licenseconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1LicenseConfig>>;
|
|
34426
|
+
get(params: Params$Resource$Projects$Locations$Licenseconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
34427
|
+
get(params: Params$Resource$Projects$Locations$Licenseconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1LicenseConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1LicenseConfig>): void;
|
|
34428
|
+
get(params: Params$Resource$Projects$Locations$Licenseconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1LicenseConfig>): void;
|
|
34429
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1LicenseConfig>): void;
|
|
31928
34430
|
/**
|
|
31929
|
-
*
|
|
34431
|
+
* Updates the LicenseConfig
|
|
31930
34432
|
* @example
|
|
31931
34433
|
* ```js
|
|
31932
34434
|
* // Before running the sample:
|
|
@@ -31955,25 +34457,43 @@ export declare namespace discoveryengine_v1 {
|
|
|
31955
34457
|
* google.options({auth: authClient});
|
|
31956
34458
|
*
|
|
31957
34459
|
* // Do the magic
|
|
31958
|
-
* const res =
|
|
31959
|
-
*
|
|
31960
|
-
*
|
|
31961
|
-
*
|
|
31962
|
-
*
|
|
31963
|
-
*
|
|
31964
|
-
*
|
|
31965
|
-
*
|
|
31966
|
-
*
|
|
31967
|
-
*
|
|
31968
|
-
*
|
|
31969
|
-
*
|
|
31970
|
-
*
|
|
34460
|
+
* const res = await discoveryengine.projects.locations.licenseConfigs.patch({
|
|
34461
|
+
* // Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}`
|
|
34462
|
+
* name: 'projects/my-project/locations/my-location/licenseConfigs/my-licenseConfig',
|
|
34463
|
+
* // Optional. Indicates which fields in the provided LicenseConfig to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
|
|
34464
|
+
* updateMask: 'placeholder-value',
|
|
34465
|
+
*
|
|
34466
|
+
* // Request body metadata
|
|
34467
|
+
* requestBody: {
|
|
34468
|
+
* // request body parameters
|
|
34469
|
+
* // {
|
|
34470
|
+
* // "alertPolicyResourceConfig": {},
|
|
34471
|
+
* // "autoRenew": false,
|
|
34472
|
+
* // "endDate": {},
|
|
34473
|
+
* // "freeTrial": false,
|
|
34474
|
+
* // "licenseCount": "my_licenseCount",
|
|
34475
|
+
* // "name": "my_name",
|
|
34476
|
+
* // "startDate": {},
|
|
34477
|
+
* // "state": "my_state",
|
|
34478
|
+
* // "subscriptionTerm": "my_subscriptionTerm",
|
|
34479
|
+
* // "subscriptionTier": "my_subscriptionTier"
|
|
34480
|
+
* // }
|
|
34481
|
+
* },
|
|
34482
|
+
* });
|
|
31971
34483
|
* console.log(res.data);
|
|
31972
34484
|
*
|
|
31973
34485
|
* // Example response
|
|
31974
34486
|
* // {
|
|
31975
|
-
* // "
|
|
31976
|
-
* // "
|
|
34487
|
+
* // "alertPolicyResourceConfig": {},
|
|
34488
|
+
* // "autoRenew": false,
|
|
34489
|
+
* // "endDate": {},
|
|
34490
|
+
* // "freeTrial": false,
|
|
34491
|
+
* // "licenseCount": "my_licenseCount",
|
|
34492
|
+
* // "name": "my_name",
|
|
34493
|
+
* // "startDate": {},
|
|
34494
|
+
* // "state": "my_state",
|
|
34495
|
+
* // "subscriptionTerm": "my_subscriptionTerm",
|
|
34496
|
+
* // "subscriptionTier": "my_subscriptionTier"
|
|
31977
34497
|
* // }
|
|
31978
34498
|
* }
|
|
31979
34499
|
*
|
|
@@ -31989,36 +34509,46 @@ export declare namespace discoveryengine_v1 {
|
|
|
31989
34509
|
* @param callback - Optional callback that handles the response.
|
|
31990
34510
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
31991
34511
|
*/
|
|
31992
|
-
|
|
31993
|
-
|
|
31994
|
-
|
|
31995
|
-
|
|
31996
|
-
|
|
31997
|
-
|
|
34512
|
+
patch(params: Params$Resource$Projects$Locations$Licenseconfigs$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
34513
|
+
patch(params?: Params$Resource$Projects$Locations$Licenseconfigs$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1LicenseConfig>>;
|
|
34514
|
+
patch(params: Params$Resource$Projects$Locations$Licenseconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
34515
|
+
patch(params: Params$Resource$Projects$Locations$Licenseconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1LicenseConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1LicenseConfig>): void;
|
|
34516
|
+
patch(params: Params$Resource$Projects$Locations$Licenseconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1LicenseConfig>): void;
|
|
34517
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1LicenseConfig>): void;
|
|
31998
34518
|
}
|
|
31999
|
-
export interface Params$Resource$Projects$Locations$
|
|
34519
|
+
export interface Params$Resource$Projects$Locations$Licenseconfigs$Create extends StandardParameters {
|
|
32000
34520
|
/**
|
|
32001
|
-
* The
|
|
34521
|
+
* Optional. The ID to use for the LicenseConfig, which will become the final component of the LicenseConfig's resource name. We are using the tier (product edition) name as the license config id such as `search` or `search_and_assistant`.
|
|
32002
34522
|
*/
|
|
32003
|
-
|
|
34523
|
+
licenseConfigId?: string;
|
|
34524
|
+
/**
|
|
34525
|
+
* Required. The parent resource name, such as `projects/{project\}/locations/{location\}`.
|
|
34526
|
+
*/
|
|
34527
|
+
parent?: string;
|
|
34528
|
+
/**
|
|
34529
|
+
* Request body metadata
|
|
34530
|
+
*/
|
|
34531
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1LicenseConfig;
|
|
32004
34532
|
}
|
|
32005
|
-
export interface Params$Resource$Projects$Locations$
|
|
34533
|
+
export interface Params$Resource$Projects$Locations$Licenseconfigs$Get extends StandardParameters {
|
|
32006
34534
|
/**
|
|
32007
|
-
*
|
|
34535
|
+
* Required. Full resource name of LicenseConfig, such as `projects/{project\}/locations/{location\}/licenseConfigs/x`. If the caller does not have permission to access the LicenseConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested LicenseConfig does not exist, a NOT_FOUND error is returned.
|
|
32008
34536
|
*/
|
|
32009
|
-
|
|
34537
|
+
name?: string;
|
|
34538
|
+
}
|
|
34539
|
+
export interface Params$Resource$Projects$Locations$Licenseconfigs$Patch extends StandardParameters {
|
|
32010
34540
|
/**
|
|
32011
|
-
* The name of the
|
|
34541
|
+
* Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}`
|
|
32012
34542
|
*/
|
|
32013
34543
|
name?: string;
|
|
32014
34544
|
/**
|
|
32015
|
-
*
|
|
34545
|
+
* Optional. Indicates which fields in the provided LicenseConfig to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
|
|
32016
34546
|
*/
|
|
32017
|
-
|
|
34547
|
+
updateMask?: string;
|
|
32018
34548
|
/**
|
|
32019
|
-
*
|
|
34549
|
+
* Request body metadata
|
|
32020
34550
|
*/
|
|
32021
|
-
|
|
34551
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1LicenseConfig;
|
|
32022
34552
|
}
|
|
32023
34553
|
export class Resource$Projects$Locations$Operations {
|
|
32024
34554
|
context: APIRequestContext;
|
|
@@ -32126,13 +34656,16 @@ export declare namespace discoveryengine_v1 {
|
|
|
32126
34656
|
* pageSize: 'placeholder-value',
|
|
32127
34657
|
* // The standard list page token.
|
|
32128
34658
|
* pageToken: 'placeholder-value',
|
|
34659
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
34660
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
32129
34661
|
* });
|
|
32130
34662
|
* console.log(res.data);
|
|
32131
34663
|
*
|
|
32132
34664
|
* // Example response
|
|
32133
34665
|
* // {
|
|
32134
34666
|
* // "nextPageToken": "my_nextPageToken",
|
|
32135
|
-
* // "operations": []
|
|
34667
|
+
* // "operations": [],
|
|
34668
|
+
* // "unreachable": []
|
|
32136
34669
|
* // }
|
|
32137
34670
|
* }
|
|
32138
34671
|
*
|
|
@@ -32178,6 +34711,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
32178
34711
|
* The standard list page token.
|
|
32179
34712
|
*/
|
|
32180
34713
|
pageToken?: string;
|
|
34714
|
+
/**
|
|
34715
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
34716
|
+
*/
|
|
34717
|
+
returnPartialSuccess?: boolean;
|
|
32181
34718
|
}
|
|
32182
34719
|
export class Resource$Projects$Locations$Podcasts {
|
|
32183
34720
|
context: APIRequestContext;
|
|
@@ -33000,13 +35537,16 @@ export declare namespace discoveryengine_v1 {
|
|
|
33000
35537
|
* pageSize: 'placeholder-value',
|
|
33001
35538
|
* // The standard list page token.
|
|
33002
35539
|
* pageToken: 'placeholder-value',
|
|
35540
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
35541
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
33003
35542
|
* });
|
|
33004
35543
|
* console.log(res.data);
|
|
33005
35544
|
*
|
|
33006
35545
|
* // Example response
|
|
33007
35546
|
* // {
|
|
33008
35547
|
* // "nextPageToken": "my_nextPageToken",
|
|
33009
|
-
* // "operations": []
|
|
35548
|
+
* // "operations": [],
|
|
35549
|
+
* // "unreachable": []
|
|
33010
35550
|
* // }
|
|
33011
35551
|
* }
|
|
33012
35552
|
*
|
|
@@ -33062,6 +35602,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
33062
35602
|
* The standard list page token.
|
|
33063
35603
|
*/
|
|
33064
35604
|
pageToken?: string;
|
|
35605
|
+
/**
|
|
35606
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
35607
|
+
*/
|
|
35608
|
+
returnPartialSuccess?: boolean;
|
|
33065
35609
|
}
|
|
33066
35610
|
export {};
|
|
33067
35611
|
}
|