Skip to content

Commit b8b4f53

Browse files
feat(discoveryengine): update the api
#### discoveryengine:v1 The following keys were added: - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig.properties.tenant.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaTenant (Total Keys: 5) #### discoveryengine:v1alpha The following keys were added: - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig.properties.tenant.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaTenant (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.dataSourceDisplayName (Total Keys: 2) #### discoveryengine:v1beta The following keys were added: - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig.properties.tenant.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaTenant (Total Keys: 5)
1 parent 5bd3e6d commit b8b4f53

10 files changed

+157
-39
lines changed

docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.connectorRuns.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,9 @@ <h3>Method Details</h3>
111111
&quot;endTime&quot;: &quot;A String&quot;, # Output only. The time when the connector run ended.
112112
&quot;entityRuns&quot;: [ # Output only. The details of the entities synced at the ConnectorRun. Each ConnectorRun consists of syncing one or more entities.
113113
{ # Represents an entity that was synced in this ConnectorRun.
114-
&quot;deletedRecordCount&quot;: &quot;A String&quot;, # The number of documents deleted.
114+
&quot;deletedRecordCount&quot;: &quot;A String&quot;, # Optional. The number of documents deleted.
115115
&quot;entityName&quot;: &quot;A String&quot;, # The name of the source entity.
116-
&quot;errorRecordCount&quot;: &quot;A String&quot;, # The total number of documents failed at sync at any stage (extraction, indexing, etc).
116+
&quot;errorRecordCount&quot;: &quot;A String&quot;, # Optional. The total number of documents failed at sync at indexing stage.
117117
&quot;errors&quot;: [ # The errors from the entity&#x27;s sync run. Only exist if running into an error state. Contains error code and error message.
118118
{ # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
119119
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
@@ -125,15 +125,15 @@ <h3>Method Details</h3>
125125
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
126126
},
127127
],
128-
&quot;extractedRecordCount&quot;: &quot;A String&quot;, # The number of documents extracted from connector source, ready to be ingested to VAIS.
129-
&quot;indexedRecordCount&quot;: &quot;A String&quot;, # The number of documents indexed.
128+
&quot;extractedRecordCount&quot;: &quot;A String&quot;, # Optional. The number of documents extracted from connector source, ready to be ingested to VAIS.
129+
&quot;indexedRecordCount&quot;: &quot;A String&quot;, # Optional. The number of documents indexed.
130130
&quot;progress&quot;: { # Represents the progress of a sync run. # Metadata to generate the progress bar.
131131
&quot;currentCount&quot;: &quot;A String&quot;, # The current progress.
132132
&quot;percentile&quot;: 3.14, # Derived. The percentile of the progress.current_count / total_count. The value is between [0, 1.0] inclusive.
133133
&quot;totalCount&quot;: &quot;A String&quot;, # The total.
134134
},
135-
&quot;scheduledRecordCount&quot;: &quot;A String&quot;, # The number of documents scheduled to be crawled/extracted from connector source. This only applies to third party connectors.
136-
&quot;sourceApiRequestCount&quot;: &quot;A String&quot;, # The number of requests sent to 3p API.
135+
&quot;scheduledRecordCount&quot;: &quot;A String&quot;, # Optional. The number of documents scheduled to be crawled/extracted from connector source. This only applies to third party connectors.
136+
&quot;sourceApiRequestCount&quot;: &quot;A String&quot;, # Optional. The number of requests sent to 3p API.
137137
&quot;state&quot;: &quot;A String&quot;, # The state of the entity&#x27;s sync run.
138138
&quot;stateUpdateTime&quot;: &quot;A String&quot;, # Timestamp at which the entity sync state was last updated.
139139
&quot;statsUpdateTime&quot;: &quot;A String&quot;, # The timestamp for either extracted_documents_count, indexed_documents_count and error_documents_count was last updated.

docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,9 @@ <h3>Method Details</h3>
156156
&quot;endTime&quot;: &quot;A String&quot;, # Output only. The time when the connector run ended.
157157
&quot;entityRuns&quot;: [ # Output only. The details of the entities synced at the ConnectorRun. Each ConnectorRun consists of syncing one or more entities.
158158
{ # Represents an entity that was synced in this ConnectorRun.
159-
&quot;deletedRecordCount&quot;: &quot;A String&quot;, # The number of documents deleted.
159+
&quot;deletedRecordCount&quot;: &quot;A String&quot;, # Optional. The number of documents deleted.
160160
&quot;entityName&quot;: &quot;A String&quot;, # The name of the source entity.
161-
&quot;errorRecordCount&quot;: &quot;A String&quot;, # The total number of documents failed at sync at any stage (extraction, indexing, etc).
161+
&quot;errorRecordCount&quot;: &quot;A String&quot;, # Optional. The total number of documents failed at sync at indexing stage.
162162
&quot;errors&quot;: [ # The errors from the entity&#x27;s sync run. Only exist if running into an error state. Contains error code and error message.
163163
{ # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
164164
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
@@ -170,15 +170,15 @@ <h3>Method Details</h3>
170170
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
171171
},
172172
],
173-
&quot;extractedRecordCount&quot;: &quot;A String&quot;, # The number of documents extracted from connector source, ready to be ingested to VAIS.
174-
&quot;indexedRecordCount&quot;: &quot;A String&quot;, # The number of documents indexed.
173+
&quot;extractedRecordCount&quot;: &quot;A String&quot;, # Optional. The number of documents extracted from connector source, ready to be ingested to VAIS.
174+
&quot;indexedRecordCount&quot;: &quot;A String&quot;, # Optional. The number of documents indexed.
175175
&quot;progress&quot;: { # Represents the progress of a sync run. # Metadata to generate the progress bar.
176176
&quot;currentCount&quot;: &quot;A String&quot;, # The current progress.
177177
&quot;percentile&quot;: 3.14, # Derived. The percentile of the progress.current_count / total_count. The value is between [0, 1.0] inclusive.
178178
&quot;totalCount&quot;: &quot;A String&quot;, # The total.
179179
},
180-
&quot;scheduledRecordCount&quot;: &quot;A String&quot;, # The number of documents scheduled to be crawled/extracted from connector source. This only applies to third party connectors.
181-
&quot;sourceApiRequestCount&quot;: &quot;A String&quot;, # The number of requests sent to 3p API.
180+
&quot;scheduledRecordCount&quot;: &quot;A String&quot;, # Optional. The number of documents scheduled to be crawled/extracted from connector source. This only applies to third party connectors.
181+
&quot;sourceApiRequestCount&quot;: &quot;A String&quot;, # Optional. The number of requests sent to 3p API.
182182
&quot;state&quot;: &quot;A String&quot;, # The state of the entity&#x27;s sync run.
183183
&quot;stateUpdateTime&quot;: &quot;A String&quot;, # Timestamp at which the entity sync state was last updated.
184184
&quot;statsUpdateTime&quot;: &quot;A String&quot;, # The timestamp for either extracted_documents_count, indexed_documents_count and error_documents_count was last updated.

docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ <h3>Method Details</h3>
123123
{ # Read-only collection component that contains data store collections fields that may be used for filtering
124124
&quot;connectorIconLink&quot;: &quot;A String&quot;, # Output only. The icon link of the connector source.
125125
&quot;dataSource&quot;: &quot;A String&quot;, # The name of the data source, retrieved from `Collection.data_connector.data_source`.
126+
&quot;dataSourceDisplayName&quot;: &quot;A String&quot;, # Output only. The display name of the data source.
126127
&quot;dataStoreComponents&quot;: [ # For the data store collection, list of the children data stores.
127128
{ # Read-only data store component that contains data stores fields that may be used for filtering, it&#x27;s the child of `CollectionComponent`.
128129
&quot;contentConfig&quot;: &quot;A String&quot;, # Output only. The content config of the data store.

docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ <h3>Method Details</h3>
123123
{ # Read-only collection component that contains data store collections fields that may be used for filtering
124124
&quot;connectorIconLink&quot;: &quot;A String&quot;, # Output only. The icon link of the connector source.
125125
&quot;dataSource&quot;: &quot;A String&quot;, # The name of the data source, retrieved from `Collection.data_connector.data_source`.
126+
&quot;dataSourceDisplayName&quot;: &quot;A String&quot;, # Output only. The display name of the data source.
126127
&quot;dataStoreComponents&quot;: [ # For the data store collection, list of the children data stores.
127128
{ # Read-only data store component that contains data stores fields that may be used for filtering, it&#x27;s the child of `CollectionComponent`.
128129
&quot;contentConfig&quot;: &quot;A String&quot;, # Output only. The content config of the data store.

docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,11 @@ <h3>Method Details</h3>
233233
&quot;authParams&quot;: { # Optional. Any authentication parameters specific to EUA connectors.
234234
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
235235
},
236+
&quot;tenant&quot;: { # 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. # Optional. The tenant project the connector is connected to.
237+
&quot;displayName&quot;: &quot;A String&quot;, # Optional display name for the tenant, e.g. &quot;My Slack Team&quot;.
238+
&quot;id&quot;: &quot;A String&quot;, # The tenant&#x27;s instance ID. Examples: Jira (&quot;8594f221-9797-5f78-1fa4-485e198d7cd0&quot;), Slack (&quot;T123456&quot;).
239+
&quot;uri&quot;: &quot;A String&quot;, # 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.
240+
},
236241
},
237242
&quot;entities&quot;: [ # List of entities from the connected data source to ingest.
238243
{ # Represents an entity in the data source. For example, the `Account` object in Salesforce.
@@ -421,6 +426,11 @@ <h3>Method Details</h3>
421426
&quot;authParams&quot;: { # Optional. Any authentication parameters specific to EUA connectors.
422427
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
423428
},
429+
&quot;tenant&quot;: { # 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. # Optional. The tenant project the connector is connected to.
430+
&quot;displayName&quot;: &quot;A String&quot;, # Optional display name for the tenant, e.g. &quot;My Slack Team&quot;.
431+
&quot;id&quot;: &quot;A String&quot;, # The tenant&#x27;s instance ID. Examples: Jira (&quot;8594f221-9797-5f78-1fa4-485e198d7cd0&quot;), Slack (&quot;T123456&quot;).
432+
&quot;uri&quot;: &quot;A String&quot;, # 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.
433+
},
424434
},
425435
&quot;entities&quot;: [ # List of entities from the connected data source to ingest.
426436
{ # Represents an entity in the data source. For example, the `Account` object in Salesforce.
@@ -613,6 +623,11 @@ <h3>Method Details</h3>
613623
&quot;authParams&quot;: { # Optional. Any authentication parameters specific to EUA connectors.
614624
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
615625
},
626+
&quot;tenant&quot;: { # 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. # Optional. The tenant project the connector is connected to.
627+
&quot;displayName&quot;: &quot;A String&quot;, # Optional display name for the tenant, e.g. &quot;My Slack Team&quot;.
628+
&quot;id&quot;: &quot;A String&quot;, # The tenant&#x27;s instance ID. Examples: Jira (&quot;8594f221-9797-5f78-1fa4-485e198d7cd0&quot;), Slack (&quot;T123456&quot;).
629+
&quot;uri&quot;: &quot;A String&quot;, # 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.
630+
},
616631
},
617632
&quot;entities&quot;: [ # List of entities from the connected data source to ingest.
618633
{ # Represents an entity in the data source. For example, the `Account` object in Salesforce.
@@ -815,6 +830,11 @@ <h3>Method Details</h3>
815830
&quot;authParams&quot;: { # Optional. Any authentication parameters specific to EUA connectors.
816831
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
817832
},
833+
&quot;tenant&quot;: { # 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. # Optional. The tenant project the connector is connected to.
834+
&quot;displayName&quot;: &quot;A String&quot;, # Optional display name for the tenant, e.g. &quot;My Slack Team&quot;.
835+
&quot;id&quot;: &quot;A String&quot;, # The tenant&#x27;s instance ID. Examples: Jira (&quot;8594f221-9797-5f78-1fa4-485e198d7cd0&quot;), Slack (&quot;T123456&quot;).
836+
&quot;uri&quot;: &quot;A String&quot;, # 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.
837+
},
818838
},
819839
&quot;entities&quot;: [ # List of entities from the connected data source to ingest.
820840
{ # Represents an entity in the data source. For example, the `Account` object in Salesforce.
@@ -1027,6 +1047,11 @@ <h3>Method Details</h3>
10271047
&quot;authParams&quot;: { # Optional. Any authentication parameters specific to EUA connectors.
10281048
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
10291049
},
1050+
&quot;tenant&quot;: { # 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. # Optional. The tenant project the connector is connected to.
1051+
&quot;displayName&quot;: &quot;A String&quot;, # Optional display name for the tenant, e.g. &quot;My Slack Team&quot;.
1052+
&quot;id&quot;: &quot;A String&quot;, # The tenant&#x27;s instance ID. Examples: Jira (&quot;8594f221-9797-5f78-1fa4-485e198d7cd0&quot;), Slack (&quot;T123456&quot;).
1053+
&quot;uri&quot;: &quot;A String&quot;, # 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.
1054+
},
10301055
},
10311056
&quot;entities&quot;: [ # List of entities from the connected data source to ingest.
10321057
{ # Represents an entity in the data source. For example, the `Account` object in Salesforce.
@@ -1206,6 +1231,11 @@ <h3>Method Details</h3>
12061231
&quot;authParams&quot;: { # Optional. Any authentication parameters specific to EUA connectors.
12071232
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
12081233
},
1234+
&quot;tenant&quot;: { # 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. # Optional. The tenant project the connector is connected to.
1235+
&quot;displayName&quot;: &quot;A String&quot;, # Optional display name for the tenant, e.g. &quot;My Slack Team&quot;.
1236+
&quot;id&quot;: &quot;A String&quot;, # The tenant&#x27;s instance ID. Examples: Jira (&quot;8594f221-9797-5f78-1fa4-485e198d7cd0&quot;), Slack (&quot;T123456&quot;).
1237+
&quot;uri&quot;: &quot;A String&quot;, # 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.
1238+
},
12091239
},
12101240
&quot;entities&quot;: [ # List of entities from the connected data source to ingest.
12111241
{ # Represents an entity in the data source. For example, the `Account` object in Salesforce.

docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ <h3>Method Details</h3>
123123
{ # Read-only collection component that contains data store collections fields that may be used for filtering
124124
&quot;connectorIconLink&quot;: &quot;A String&quot;, # Output only. The icon link of the connector source.
125125
&quot;dataSource&quot;: &quot;A String&quot;, # The name of the data source, retrieved from `Collection.data_connector.data_source`.
126+
&quot;dataSourceDisplayName&quot;: &quot;A String&quot;, # Output only. The display name of the data source.
126127
&quot;dataStoreComponents&quot;: [ # For the data store collection, list of the children data stores.
127128
{ # Read-only data store component that contains data stores fields that may be used for filtering, it&#x27;s the child of `CollectionComponent`.
128129
&quot;contentConfig&quot;: &quot;A String&quot;, # Output only. The content config of the data store.

docs/dyn/discoveryengine_v1alpha.projects.locations.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -993,6 +993,11 @@ <h3>Method Details</h3>
993993
&quot;authParams&quot;: { # Optional. Any authentication parameters specific to EUA connectors.
994994
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
995995
},
996+
&quot;tenant&quot;: { # 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. # Optional. The tenant project the connector is connected to.
997+
&quot;displayName&quot;: &quot;A String&quot;, # Optional display name for the tenant, e.g. &quot;My Slack Team&quot;.
998+
&quot;id&quot;: &quot;A String&quot;, # The tenant&#x27;s instance ID. Examples: Jira (&quot;8594f221-9797-5f78-1fa4-485e198d7cd0&quot;), Slack (&quot;T123456&quot;).
999+
&quot;uri&quot;: &quot;A String&quot;, # 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.
1000+
},
9961001
},
9971002
&quot;entities&quot;: [ # List of entities from the connected data source to ingest.
9981003
{ # Represents an entity in the data source. For example, the `Account` object in Salesforce.

0 commit comments

Comments
 (0)