Skip to content

Commit bb4945c

Browse files
feat(connectors): update the api
#### connectors:v2 The following keys were deleted: - resources.projects.resources.locations.resources.connections.resources.entityTypes.resources.entitieswithacls.methods.list.parameters.pageSize (Total Keys: 3) - resources.projects.resources.locations.resources.connections.resources.entityTypes.resources.entitieswithacls.methods.list.parameters.pageToken (Total Keys: 2) - resources.projects.resources.locations.resources.connections.resources.entityTypes.resources.entitieswithacls.methods.list.parameters.sortBy (Total Keys: 3) - schemas.AclInfo (Total Keys: 4) - schemas.EntityWithACL (Total Keys: 6) - schemas.ListEntitiesWithACLsResponse (Total Keys: 5) - schemas.Principal (Total Keys: 4) - schemas.Readers (Total Keys: 4) The following keys were added: - schemas.Operation (Total Keys: 9) - schemas.Status (Total Keys: 8) The following keys were changed: - resources.projects.resources.locations.resources.connections.resources.entityTypes.resources.entitieswithacls.methods.list.response.$ref (Total Keys: 1)
1 parent ec43c8d commit bb4945c

File tree

2 files changed

+83
-140
lines changed

2 files changed

+83
-140
lines changed

docs/dyn/connectors_v2.projects.locations.connections.entityTypes.entitieswithacls.html

Lines changed: 19 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -78,28 +78,22 @@ <h2>Instance Methods</h2>
7878
<code><a href="#close">close()</a></code></p>
7979
<p class="firstline">Close httplib2 connections.</p>
8080
<p class="toc_element">
81-
<code><a href="#list">list(parent, conditions=None, gsutilUri=None, pageSize=None, pageToken=None, sortBy=None, x__xgafv=None)</a></code></p>
81+
<code><a href="#list">list(parent, conditions=None, gsutilUri=None, x__xgafv=None)</a></code></p>
8282
<p class="firstline">Lists entity rows with ACLs of a particular entity type contained in the request. Note: 1. Currently, only max of one 'sort_by' column is supported. 2. If no 'sort_by' column is provided, the primary key of the table is used. If zero or more than one primary key is available, we default to the unpaginated list entities logic which only returns the first page. 3. The values of the 'sort_by' columns must uniquely identify an entity row, otherwise undefined behaviors may be observed during pagination. 4. Since transactions are not supported, any updates, inserts or deletes during pagination can lead to stale data being returned or other unexpected behaviors.</p>
83-
<p class="toc_element">
84-
<code><a href="#list_next">list_next()</a></code></p>
85-
<p class="firstline">Retrieves the next page of results.</p>
8683
<h3>Method Details</h3>
8784
<div class="method">
8885
<code class="details" id="close">close()</code>
8986
<pre>Close httplib2 connections.</pre>
9087
</div>
9188

9289
<div class="method">
93-
<code class="details" id="list">list(parent, conditions=None, gsutilUri=None, pageSize=None, pageToken=None, sortBy=None, x__xgafv=None)</code>
90+
<code class="details" id="list">list(parent, conditions=None, gsutilUri=None, x__xgafv=None)</code>
9491
<pre>Lists entity rows with ACLs of a particular entity type contained in the request. Note: 1. Currently, only max of one &#x27;sort_by&#x27; column is supported. 2. If no &#x27;sort_by&#x27; column is provided, the primary key of the table is used. If zero or more than one primary key is available, we default to the unpaginated list entities logic which only returns the first page. 3. The values of the &#x27;sort_by&#x27; columns must uniquely identify an entity row, otherwise undefined behaviors may be observed during pagination. 4. Since transactions are not supported, any updates, inserts or deletes during pagination can lead to stale data being returned or other unexpected behaviors.
9592

9693
Args:
9794
parent: string, Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} (required)
9895
conditions: string, Conditions to be used when listing entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported.
9996
gsutilUri: string, Format: gs://object_path
100-
pageSize: integer, Number of entity rows to return. Defaults page size = 25. Max page size = 200.
101-
pageToken: string, Page token value if available from a previous request.
102-
sortBy: string, List of &#x27;sort_by&#x27; columns to use when returning the results. (repeated)
10397
x__xgafv: string, V1 error format.
10498
Allowed values
10599
1 - v1 error format
@@ -108,41 +102,25 @@ <h3>Method Details</h3>
108102
Returns:
109103
An object of the form:
110104

111-
{ # Response message for EntityService.ListEntitiesWithACLs
112-
&quot;entitiesWithAcl&quot;: [ # List containing entity rows.
113-
{ # EntityWithACL refers to a single row of an entity type with ACL information.
114-
&quot;acl_info&quot;: { # AclInfo has a list of readers for a resource. This is defined as per the below docs https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.branches.documents#aclinfo # ACL information of the entity.
115-
&quot;readers&quot;: [ # A list of readers for a resource.
116-
{ # Readers is a list of principals that have read access to a resource.
117-
&quot;principals&quot;: [ # A list of principals that have read access to a resource.
118-
{ # Principal is a user or group that has access to a resource.
119-
&quot;group_id&quot;: &quot;A String&quot;, # The group that has access to a resource.
120-
&quot;user_id&quot;: &quot;A String&quot;, # The user that has access to a resource.
121-
},
122-
],
123-
},
124-
],
105+
{ # This resource represents a long-running operation that is the result of a network API call.
106+
&quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
107+
&quot;error&quot;: { # 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). # The error result of the operation in case of failure or cancellation.
108+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
109+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
110+
{
111+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
125112
},
126-
&quot;id&quot;: &quot;A String&quot;,
127-
&quot;jsonData&quot;: &quot;A String&quot;, # Entity data in JSON format.
128-
},
129-
],
130-
&quot;nextPageToken&quot;: &quot;A String&quot;, # Next page token if more records are available.
113+
],
114+
&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.
115+
},
116+
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
117+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
118+
},
119+
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
120+
&quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
121+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
122+
},
131123
}</pre>
132124
</div>
133125

134-
<div class="method">
135-
<code class="details" id="list_next">list_next()</code>
136-
<pre>Retrieves the next page of results.
137-
138-
Args:
139-
previous_request: The request for the previous page. (required)
140-
previous_response: The response from the request for the previous page. (required)
141-
142-
Returns:
143-
A request object that you can call &#x27;execute()&#x27; on to request the next
144-
page. Returns None if there are no more items in the collection.
145-
</pre>
146-
</div>
147-
148126
</body></html>

googleapiclient/discovery_cache/documents/connectors.v2.json

Lines changed: 64 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -672,34 +672,17 @@
672672
"location": "query",
673673
"type": "string"
674674
},
675-
"pageSize": {
676-
"description": "Number of entity rows to return. Defaults page size = 25. Max page size = 200.",
677-
"format": "int32",
678-
"location": "query",
679-
"type": "integer"
680-
},
681-
"pageToken": {
682-
"description": "Page token value if available from a previous request.",
683-
"location": "query",
684-
"type": "string"
685-
},
686675
"parent": {
687676
"description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}",
688677
"location": "path",
689678
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$",
690679
"required": true,
691680
"type": "string"
692-
},
693-
"sortBy": {
694-
"description": "List of 'sort_by' columns to use when returning the results.",
695-
"location": "query",
696-
"repeated": true,
697-
"type": "string"
698681
}
699682
},
700683
"path": "v2/{+parent}/entitieswithacls",
701684
"response": {
702-
"$ref": "ListEntitiesWithACLsResponse"
685+
"$ref": "Operation"
703686
},
704687
"scopes": [
705688
"https://www.googleapis.com/auth/cloud-platform"
@@ -716,7 +699,7 @@
716699
}
717700
}
718701
},
719-
"revision": "20240529",
702+
"revision": "20240606",
720703
"rootUrl": "https://connectors.googleapis.com/",
721704
"schemas": {
722705
"AccessCredentials": {
@@ -739,20 +722,6 @@
739722
},
740723
"type": "object"
741724
},
742-
"AclInfo": {
743-
"description": "AclInfo has a list of readers for a resource. This is defined as per the below docs https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.branches.documents#aclinfo",
744-
"id": "AclInfo",
745-
"properties": {
746-
"readers": {
747-
"description": "A list of readers for a resource.",
748-
"items": {
749-
"$ref": "Readers"
750-
},
751-
"type": "array"
752-
}
753-
},
754-
"type": "object"
755-
},
756725
"Action": {
757726
"description": "Action message contains metadata information about a single action present in the external system.",
758727
"id": "Action",
@@ -957,25 +926,6 @@
957926
},
958927
"type": "object"
959928
},
960-
"EntityWithACL": {
961-
"description": "EntityWithACL refers to a single row of an entity type with ACL information.",
962-
"id": "EntityWithACL",
963-
"properties": {
964-
"acl_info": {
965-
"$ref": "AclInfo",
966-
"description": "ACL information of the entity."
967-
},
968-
"id": {
969-
"readOnly": true,
970-
"type": "string"
971-
},
972-
"jsonData": {
973-
"description": "Entity data in JSON format.",
974-
"type": "string"
975-
}
976-
},
977-
"type": "object"
978-
},
979929
"ExchangeAuthCodeRequest": {
980930
"description": "ExchangeAuthCodeRequest currently includes no fields.",
981931
"id": "ExchangeAuthCodeRequest",
@@ -1792,24 +1742,6 @@ false
17921742
},
17931743
"type": "object"
17941744
},
1795-
"ListEntitiesWithACLsResponse": {
1796-
"description": "Response message for EntityService.ListEntitiesWithACLs",
1797-
"id": "ListEntitiesWithACLsResponse",
1798-
"properties": {
1799-
"entitiesWithAcl": {
1800-
"description": "List containing entity rows.",
1801-
"items": {
1802-
"$ref": "EntityWithACL"
1803-
},
1804-
"type": "array"
1805-
},
1806-
"nextPageToken": {
1807-
"description": "Next page token if more records are available.",
1808-
"type": "string"
1809-
}
1810-
},
1811-
"type": "object"
1812-
},
18131745
"ListEntityTypesResponse": {
18141746
"description": "Response message for EntityService.ListEntityTypes",
18151747
"id": "ListEntityTypesResponse",
@@ -1986,31 +1918,51 @@ false
19861918
},
19871919
"type": "object"
19881920
},
1989-
"PerSliSloEligibility": {
1990-
"description": "PerSliSloEligibility is a mapping from an SLI name to eligibility.",
1991-
"id": "PerSliSloEligibility",
1921+
"Operation": {
1922+
"description": "This resource represents a long-running operation that is the result of a network API call.",
1923+
"id": "Operation",
19921924
"properties": {
1993-
"eligibilities": {
1925+
"done": {
1926+
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
1927+
"type": "boolean"
1928+
},
1929+
"error": {
1930+
"$ref": "Status",
1931+
"description": "The error result of the operation in case of failure or cancellation."
1932+
},
1933+
"metadata": {
19941934
"additionalProperties": {
1995-
"$ref": "SloEligibility"
1935+
"description": "Properties of the object. Contains field @type with type URL.",
1936+
"type": "any"
19961937
},
1997-
"description": "An entry in the eligibilities map specifies an eligibility for a particular SLI for the given instance. The SLI key in the name must be a valid SLI name specified in the Eligibility Exporter binary flags otherwise an error will be emitted by Eligibility Exporter and the oncaller will be alerted. If an SLI has been defined in the binary flags but the eligibilities map does not contain it, the corresponding SLI time series will not be emitted by the Eligibility Exporter. This ensures a smooth rollout and compatibility between the data produced by different versions of the Eligibility Exporters. If eligibilities map contains a key for an SLI which has not been declared in the binary flags, there will be an error message emitted in the Eligibility Exporter log and the metric for the SLI in question will not be emitted.",
1938+
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
1939+
"type": "object"
1940+
},
1941+
"name": {
1942+
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
1943+
"type": "string"
1944+
},
1945+
"response": {
1946+
"additionalProperties": {
1947+
"description": "Properties of the object. Contains field @type with type URL.",
1948+
"type": "any"
1949+
},
1950+
"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
19981951
"type": "object"
19991952
}
20001953
},
20011954
"type": "object"
20021955
},
2003-
"Principal": {
2004-
"description": "Principal is a user or group that has access to a resource.",
2005-
"id": "Principal",
1956+
"PerSliSloEligibility": {
1957+
"description": "PerSliSloEligibility is a mapping from an SLI name to eligibility.",
1958+
"id": "PerSliSloEligibility",
20061959
"properties": {
2007-
"group_id": {
2008-
"description": "The group that has access to a resource.",
2009-
"type": "string"
1960+
"eligibilities": {
1961+
"additionalProperties": {
1962+
"$ref": "SloEligibility"
20101963
},
2011-
"user_id": {
2012-
"description": "The user that has access to a resource.",
2013-
"type": "string"
1964+
"description": "An entry in the eligibilities map specifies an eligibility for a particular SLI for the given instance. The SLI key in the name must be a valid SLI name specified in the Eligibility Exporter binary flags otherwise an error will be emitted by Eligibility Exporter and the oncaller will be alerted. If an SLI has been defined in the binary flags but the eligibilities map does not contain it, the corresponding SLI time series will not be emitted by the Eligibility Exporter. This ensures a smooth rollout and compatibility between the data produced by different versions of the Eligibility Exporters. If eligibilities map contains a key for an SLI which has not been declared in the binary flags, there will be an error message emitted in the Eligibility Exporter log and the metric for the SLI in question will not be emitted.",
1965+
"type": "object"
20141966
}
20151967
},
20161968
"type": "object"
@@ -2212,20 +2164,6 @@ false
22122164
},
22132165
"type": "object"
22142166
},
2215-
"Readers": {
2216-
"description": "Readers is a list of principals that have read access to a resource.",
2217-
"id": "Readers",
2218-
"properties": {
2219-
"principals": {
2220-
"description": "A list of principals that have read access to a resource.",
2221-
"items": {
2222-
"$ref": "Principal"
2223-
},
2224-
"type": "array"
2225-
}
2226-
},
2227-
"type": "object"
2228-
},
22292167
"Reference": {
22302168
"id": "Reference",
22312169
"properties": {
@@ -2497,6 +2435,33 @@ false
24972435
},
24982436
"type": "object"
24992437
},
2438+
"Status": {
2439+
"description": "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).",
2440+
"id": "Status",
2441+
"properties": {
2442+
"code": {
2443+
"description": "The status code, which should be an enum value of google.rpc.Code.",
2444+
"format": "int32",
2445+
"type": "integer"
2446+
},
2447+
"details": {
2448+
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
2449+
"items": {
2450+
"additionalProperties": {
2451+
"description": "Properties of the object. Contains field @type with type URL.",
2452+
"type": "any"
2453+
},
2454+
"type": "object"
2455+
},
2456+
"type": "array"
2457+
},
2458+
"message": {
2459+
"description": "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.",
2460+
"type": "string"
2461+
}
2462+
},
2463+
"type": "object"
2464+
},
25002465
"TimeOfDay": {
25012466
"description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.",
25022467
"id": "TimeOfDay",

0 commit comments

Comments
 (0)