Skip to content

Commit ba7b7b7

Browse files
feat(connectors): update the api
#### connectors:v1 The following keys were added: - schemas.Connection.properties.trafficShapingConfigs (Total Keys: 2) - schemas.TrafficShapingConfig (Total Keys: 6) #### connectors:v2 The following keys were added: - resources.projects.resources.locations.resources.connections.resources.entityTypes.methods.get.parameters.view (Total Keys: 2)
1 parent 7bcbd8a commit ba7b7b7

File tree

4 files changed

+84
-10
lines changed

4 files changed

+84
-10
lines changed

docs/dyn/connectors_v1.projects.locations.connections.html

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ <h3>Method Details</h3>
249249
],
250250
&quot;connectionRevision&quot;: &quot;A String&quot;, # Output only. Connection revision. This field is only updated when the connection is created or updated by User.
251251
&quot;connectorVersion&quot;: &quot;A String&quot;, # Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource.
252-
&quot;connectorVersionInfraConfig&quot;: { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version.
252+
&quot;connectorVersionInfraConfig&quot;: { # This configuration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version.
253253
&quot;connectionRatelimitWindowSeconds&quot;: &quot;A String&quot;, # Output only. The window used for ratelimiting runtime requests to connections.
254254
&quot;deploymentModel&quot;: &quot;A String&quot;, # Output only. Indicates whether connector is deployed on GKE/CloudRun
255255
&quot;deploymentModelMigrationState&quot;: &quot;A String&quot;, # Output only. Status of the deployment model migration.
@@ -598,6 +598,12 @@ <h3>Method Details</h3>
598598
&quot;subscriptionType&quot;: &quot;A String&quot;, # Output only. This subscription type enum states the subscription type of the project.
599599
&quot;suspended&quot;: True or False, # Optional. Suspended indicates if a user has suspended a connection or not.
600600
&quot;tlsServiceDirectory&quot;: &quot;A String&quot;, # Output only. The name of the Service Directory service with TLS.
601+
&quot;trafficShapingConfigs&quot;: [ # Optional. Traffic shaping configuration for the connection.
602+
{ # * TrafficShapingConfig defines the configuration for shaping API traffic by specifying a quota limit and the duration over which this limit is enforced. This configuration helps to control and manage the rate at which API calls are made on the client side, preventing service overload on the backend. For example: - if the quota limit is 100 calls per 10 seconds, then the message would be: { quota_limit: 100 duration: { seconds: 10 } } - if the quota limit is 100 calls per 5 minutes, then the message would be: { quota_limit: 100 duration: { seconds: 300 } } - if the quota limit is 10000 calls per day, then the message would be: { quota_limit: 10000 duration: { seconds: 86400 } and so on.
603+
&quot;duration&quot;: &quot;A String&quot;, # Required. * The duration over which the API call quota limits are calculated. This duration is used to define the time window for evaluating if the number of API calls made by a user is within the allowed quota limits. For example: - To define a quota sampled over 16 seconds, set `seconds` to 16 - To define a quota sampled over 5 minutes, set `seconds` to 300 (5 * 60) - To define a quota sampled over 1 day, set `seconds` to 86400 (24 * 60 * 60) and so on. It is important to note that this duration is not the time the quota is valid for, but rather the time window over which the quota is evaluated. For example, if the quota is 100 calls per 10 seconds, then this duration field would be set to 10 seconds.
604+
&quot;quotaLimit&quot;: &quot;A String&quot;, # Required. Maximum number of api calls allowed.
605+
},
606+
],
601607
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
602608
}
603609

@@ -780,7 +786,7 @@ <h3>Method Details</h3>
780786
],
781787
&quot;connectionRevision&quot;: &quot;A String&quot;, # Output only. Connection revision. This field is only updated when the connection is created or updated by User.
782788
&quot;connectorVersion&quot;: &quot;A String&quot;, # Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource.
783-
&quot;connectorVersionInfraConfig&quot;: { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version.
789+
&quot;connectorVersionInfraConfig&quot;: { # This configuration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version.
784790
&quot;connectionRatelimitWindowSeconds&quot;: &quot;A String&quot;, # Output only. The window used for ratelimiting runtime requests to connections.
785791
&quot;deploymentModel&quot;: &quot;A String&quot;, # Output only. Indicates whether connector is deployed on GKE/CloudRun
786792
&quot;deploymentModelMigrationState&quot;: &quot;A String&quot;, # Output only. Status of the deployment model migration.
@@ -1129,6 +1135,12 @@ <h3>Method Details</h3>
11291135
&quot;subscriptionType&quot;: &quot;A String&quot;, # Output only. This subscription type enum states the subscription type of the project.
11301136
&quot;suspended&quot;: True or False, # Optional. Suspended indicates if a user has suspended a connection or not.
11311137
&quot;tlsServiceDirectory&quot;: &quot;A String&quot;, # Output only. The name of the Service Directory service with TLS.
1138+
&quot;trafficShapingConfigs&quot;: [ # Optional. Traffic shaping configuration for the connection.
1139+
{ # * TrafficShapingConfig defines the configuration for shaping API traffic by specifying a quota limit and the duration over which this limit is enforced. This configuration helps to control and manage the rate at which API calls are made on the client side, preventing service overload on the backend. For example: - if the quota limit is 100 calls per 10 seconds, then the message would be: { quota_limit: 100 duration: { seconds: 10 } } - if the quota limit is 100 calls per 5 minutes, then the message would be: { quota_limit: 100 duration: { seconds: 300 } } - if the quota limit is 10000 calls per day, then the message would be: { quota_limit: 10000 duration: { seconds: 86400 } and so on.
1140+
&quot;duration&quot;: &quot;A String&quot;, # Required. * The duration over which the API call quota limits are calculated. This duration is used to define the time window for evaluating if the number of API calls made by a user is within the allowed quota limits. For example: - To define a quota sampled over 16 seconds, set `seconds` to 16 - To define a quota sampled over 5 minutes, set `seconds` to 300 (5 * 60) - To define a quota sampled over 1 day, set `seconds` to 86400 (24 * 60 * 60) and so on. It is important to note that this duration is not the time the quota is valid for, but rather the time window over which the quota is evaluated. For example, if the quota is 100 calls per 10 seconds, then this duration field would be set to 10 seconds.
1141+
&quot;quotaLimit&quot;: &quot;A String&quot;, # Required. Maximum number of api calls allowed.
1142+
},
1143+
],
11321144
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
11331145
}</pre>
11341146
</div>
@@ -1330,7 +1342,7 @@ <h3>Method Details</h3>
13301342
],
13311343
&quot;connectionRevision&quot;: &quot;A String&quot;, # Output only. Connection revision. This field is only updated when the connection is created or updated by User.
13321344
&quot;connectorVersion&quot;: &quot;A String&quot;, # Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource.
1333-
&quot;connectorVersionInfraConfig&quot;: { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version.
1345+
&quot;connectorVersionInfraConfig&quot;: { # This configuration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version.
13341346
&quot;connectionRatelimitWindowSeconds&quot;: &quot;A String&quot;, # Output only. The window used for ratelimiting runtime requests to connections.
13351347
&quot;deploymentModel&quot;: &quot;A String&quot;, # Output only. Indicates whether connector is deployed on GKE/CloudRun
13361348
&quot;deploymentModelMigrationState&quot;: &quot;A String&quot;, # Output only. Status of the deployment model migration.
@@ -1679,6 +1691,12 @@ <h3>Method Details</h3>
16791691
&quot;subscriptionType&quot;: &quot;A String&quot;, # Output only. This subscription type enum states the subscription type of the project.
16801692
&quot;suspended&quot;: True or False, # Optional. Suspended indicates if a user has suspended a connection or not.
16811693
&quot;tlsServiceDirectory&quot;: &quot;A String&quot;, # Output only. The name of the Service Directory service with TLS.
1694+
&quot;trafficShapingConfigs&quot;: [ # Optional. Traffic shaping configuration for the connection.
1695+
{ # * TrafficShapingConfig defines the configuration for shaping API traffic by specifying a quota limit and the duration over which this limit is enforced. This configuration helps to control and manage the rate at which API calls are made on the client side, preventing service overload on the backend. For example: - if the quota limit is 100 calls per 10 seconds, then the message would be: { quota_limit: 100 duration: { seconds: 10 } } - if the quota limit is 100 calls per 5 minutes, then the message would be: { quota_limit: 100 duration: { seconds: 300 } } - if the quota limit is 10000 calls per day, then the message would be: { quota_limit: 10000 duration: { seconds: 86400 } and so on.
1696+
&quot;duration&quot;: &quot;A String&quot;, # Required. * The duration over which the API call quota limits are calculated. This duration is used to define the time window for evaluating if the number of API calls made by a user is within the allowed quota limits. For example: - To define a quota sampled over 16 seconds, set `seconds` to 16 - To define a quota sampled over 5 minutes, set `seconds` to 300 (5 * 60) - To define a quota sampled over 1 day, set `seconds` to 86400 (24 * 60 * 60) and so on. It is important to note that this duration is not the time the quota is valid for, but rather the time window over which the quota is evaluated. For example, if the quota is 100 calls per 10 seconds, then this duration field would be set to 10 seconds.
1697+
&quot;quotaLimit&quot;: &quot;A String&quot;, # Required. Maximum number of api calls allowed.
1698+
},
1699+
],
16821700
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
16831701
},
16841702
],
@@ -1834,7 +1852,7 @@ <h3>Method Details</h3>
18341852
],
18351853
&quot;connectionRevision&quot;: &quot;A String&quot;, # Output only. Connection revision. This field is only updated when the connection is created or updated by User.
18361854
&quot;connectorVersion&quot;: &quot;A String&quot;, # Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource.
1837-
&quot;connectorVersionInfraConfig&quot;: { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version.
1855+
&quot;connectorVersionInfraConfig&quot;: { # This configuration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version.
18381856
&quot;connectionRatelimitWindowSeconds&quot;: &quot;A String&quot;, # Output only. The window used for ratelimiting runtime requests to connections.
18391857
&quot;deploymentModel&quot;: &quot;A String&quot;, # Output only. Indicates whether connector is deployed on GKE/CloudRun
18401858
&quot;deploymentModelMigrationState&quot;: &quot;A String&quot;, # Output only. Status of the deployment model migration.
@@ -2183,6 +2201,12 @@ <h3>Method Details</h3>
21832201
&quot;subscriptionType&quot;: &quot;A String&quot;, # Output only. This subscription type enum states the subscription type of the project.
21842202
&quot;suspended&quot;: True or False, # Optional. Suspended indicates if a user has suspended a connection or not.
21852203
&quot;tlsServiceDirectory&quot;: &quot;A String&quot;, # Output only. The name of the Service Directory service with TLS.
2204+
&quot;trafficShapingConfigs&quot;: [ # Optional. Traffic shaping configuration for the connection.
2205+
{ # * TrafficShapingConfig defines the configuration for shaping API traffic by specifying a quota limit and the duration over which this limit is enforced. This configuration helps to control and manage the rate at which API calls are made on the client side, preventing service overload on the backend. For example: - if the quota limit is 100 calls per 10 seconds, then the message would be: { quota_limit: 100 duration: { seconds: 10 } } - if the quota limit is 100 calls per 5 minutes, then the message would be: { quota_limit: 100 duration: { seconds: 300 } } - if the quota limit is 10000 calls per day, then the message would be: { quota_limit: 10000 duration: { seconds: 86400 } and so on.
2206+
&quot;duration&quot;: &quot;A String&quot;, # Required. * The duration over which the API call quota limits are calculated. This duration is used to define the time window for evaluating if the number of API calls made by a user is within the allowed quota limits. For example: - To define a quota sampled over 16 seconds, set `seconds` to 16 - To define a quota sampled over 5 minutes, set `seconds` to 300 (5 * 60) - To define a quota sampled over 1 day, set `seconds` to 86400 (24 * 60 * 60) and so on. It is important to note that this duration is not the time the quota is valid for, but rather the time window over which the quota is evaluated. For example, if the quota is 100 calls per 10 seconds, then this duration field would be set to 10 seconds.
2207+
&quot;quotaLimit&quot;: &quot;A String&quot;, # Required. Maximum number of api calls allowed.
2208+
},
2209+
],
21862210
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
21872211
}
21882212

@@ -2485,7 +2509,7 @@ <h3>Method Details</h3>
24852509
],
24862510
&quot;connectionRevision&quot;: &quot;A String&quot;, # Output only. Connection revision. This field is only updated when the connection is created or updated by User.
24872511
&quot;connectorVersion&quot;: &quot;A String&quot;, # Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource.
2488-
&quot;connectorVersionInfraConfig&quot;: { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version.
2512+
&quot;connectorVersionInfraConfig&quot;: { # This configuration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version.
24892513
&quot;connectionRatelimitWindowSeconds&quot;: &quot;A String&quot;, # Output only. The window used for ratelimiting runtime requests to connections.
24902514
&quot;deploymentModel&quot;: &quot;A String&quot;, # Output only. Indicates whether connector is deployed on GKE/CloudRun
24912515
&quot;deploymentModelMigrationState&quot;: &quot;A String&quot;, # Output only. Status of the deployment model migration.
@@ -2834,6 +2858,12 @@ <h3>Method Details</h3>
28342858
&quot;subscriptionType&quot;: &quot;A String&quot;, # Output only. This subscription type enum states the subscription type of the project.
28352859
&quot;suspended&quot;: True or False, # Optional. Suspended indicates if a user has suspended a connection or not.
28362860
&quot;tlsServiceDirectory&quot;: &quot;A String&quot;, # Output only. The name of the Service Directory service with TLS.
2861+
&quot;trafficShapingConfigs&quot;: [ # Optional. Traffic shaping configuration for the connection.
2862+
{ # * TrafficShapingConfig defines the configuration for shaping API traffic by specifying a quota limit and the duration over which this limit is enforced. This configuration helps to control and manage the rate at which API calls are made on the client side, preventing service overload on the backend. For example: - if the quota limit is 100 calls per 10 seconds, then the message would be: { quota_limit: 100 duration: { seconds: 10 } } - if the quota limit is 100 calls per 5 minutes, then the message would be: { quota_limit: 100 duration: { seconds: 300 } } - if the quota limit is 10000 calls per day, then the message would be: { quota_limit: 10000 duration: { seconds: 86400 } and so on.
2863+
&quot;duration&quot;: &quot;A String&quot;, # Required. * The duration over which the API call quota limits are calculated. This duration is used to define the time window for evaluating if the number of API calls made by a user is within the allowed quota limits. For example: - To define a quota sampled over 16 seconds, set `seconds` to 16 - To define a quota sampled over 5 minutes, set `seconds` to 300 (5 * 60) - To define a quota sampled over 1 day, set `seconds` to 86400 (24 * 60 * 60) and so on. It is important to note that this duration is not the time the quota is valid for, but rather the time window over which the quota is evaluated. For example, if the quota is 100 calls per 10 seconds, then this duration field would be set to 10 seconds.
2864+
&quot;quotaLimit&quot;: &quot;A String&quot;, # Required. Maximum number of api calls allowed.
2865+
},
2866+
],
28372867
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
28382868
},
28392869
&quot;entitySchema&quot;: { # Schema of a runtime entity. # Output only. Schema of a runtime entity.

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ <h2>Instance Methods</h2>
8383
<code><a href="#close">close()</a></code></p>
8484
<p class="firstline">Close httplib2 connections.</p>
8585
<p class="toc_element">
86-
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
86+
<code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
8787
<p class="firstline">Gets metadata of given entity type</p>
8888
<p class="toc_element">
8989
<code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
@@ -98,11 +98,16 @@ <h3>Method Details</h3>
9898
</div>
9999

100100
<div class="method">
101-
<code class="details" id="get">get(name, x__xgafv=None)</code>
101+
<code class="details" id="get">get(name, view=None, x__xgafv=None)</code>
102102
<pre>Gets metadata of given entity type
103103

104104
Args:
105105
name: string, Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{entityType} (required)
106+
view: string, Specifies view for entity type schema.
107+
Allowed values
108+
ENTITY_TYPE_SCHEMA_VIEW_UNSPECIFIED - VIEW_UNSPECIFIED. The unset value. Defaults to BASIC View.
109+
ENTITY_TYPE_SCHEMA_VIEW_BASIC - Return basic entity type schema.
110+
ENTITY_TYPE_SCHEMA_VIEW_ENRICHED - Return enriched entity types schema.
106111
x__xgafv: string, V1 error format.
107112
Allowed values
108113
1 - v1 error format

0 commit comments

Comments
 (0)