Skip to content

Commit

Permalink
feat(connectors): update the api
Browse files Browse the repository at this point in the history
#### connectors:v1

The following keys were added:
- resources.projects.resources.locations.resources.connections.methods.repairEventing (Total Keys: 12)
- resources.projects.resources.locations.resources.connections.resources.eventSubscriptions.methods.create (Total Keys: 14)
- resources.projects.resources.locations.resources.connections.resources.eventSubscriptions.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.connections.resources.eventSubscriptions.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.connections.resources.eventSubscriptions.methods.list (Total Keys: 20)
- resources.projects.resources.locations.resources.connections.resources.eventSubscriptions.methods.patch (Total Keys: 15)
- resources.projects.resources.locations.resources.connections.resources.eventSubscriptions.methods.retry (Total Keys: 12)
- resources.projects.resources.locations.resources.global.methods.updateSettings (Total Keys: 15)
- resources.projects.resources.locations.resources.providers.resources.connectors.resources.versions.resources.eventtypes.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.providers.resources.connectors.resources.versions.resources.eventtypes.methods.list (Total Keys: 16)
- schemas.Connection.properties.connectorVersionInfraConfig (Total Keys: 2)
- schemas.Connection.properties.eventingConfig.$ref (Total Keys: 1)
- schemas.Connection.properties.eventingEnablementType.type (Total Keys: 1)
- schemas.Connection.properties.eventingRuntimeData (Total Keys: 2)
- schemas.Connector.properties.eventingDetails (Total Keys: 2)
- schemas.ConnectorInfraConfig (Total Keys: 4)
- schemas.ConnectorVersion.properties.connectorInfraConfig (Total Keys: 2)
- schemas.ConnectorVersion.properties.eventingConfigTemplate (Total Keys: 2)
- schemas.ConnectorVersionInfraConfig (Total Keys: 5)
- schemas.EndPoint (Total Keys: 5)
- schemas.EventSubscription (Total Keys: 23)
- schemas.EventType (Total Keys: 20)
- schemas.EventingConfig (Total Keys: 20)
- schemas.EventingDetails (Total Keys: 13)
- schemas.EventingRuntimeData (Total Keys: 6)
- schemas.EventingStatus (Total Keys: 4)
- schemas.Header (Total Keys: 4)
- schemas.ListEventSubscriptionsResponse (Total Keys: 7)
- schemas.ListEventTypesResponse (Total Keys: 5)
- schemas.RepairEventingRequest (Total Keys: 2)
- schemas.RetryEventSubscriptionRequest (Total Keys: 2)
  • Loading branch information
yoshi-automation committed Jul 11, 2023
1 parent 4ac1f14 commit 665f278
Show file tree
Hide file tree
Showing 8 changed files with 2,652 additions and 5 deletions.

Large diffs are not rendered by default.

517 changes: 517 additions & 0 deletions docs/dyn/connectors_v1.projects.locations.connections.html

Large diffs are not rendered by default.

49 changes: 49 additions & 0 deletions docs/dyn/connectors_v1.projects.locations.global_.html
Expand Up @@ -85,6 +85,9 @@ <h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#getSettings">getSettings(name, x__xgafv=None)</a></code></p>
<p class="firstline">GetGlobalSettings gets settings of a project. GlobalSettings is a singleton resource.</p>
<p class="toc_element">
<code><a href="#updateSettings">updateSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update the global settings of a project.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
Expand Down Expand Up @@ -113,4 +116,50 @@ <h3>Method Details</h3>
}</pre>
</div>

<div class="method">
<code class="details" id="updateSettings">updateSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Update the global settings of a project.

Args:
name: string, Output only. Resource name of the Connection. Format: projects/{project}/locations/global/settings} (required)
body: object, The request body.
The object takes the form of:

{ # Global Settings details.
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the Connection. Format: projects/{project}/locations/global/settings}
&quot;payg&quot;: True or False, # Output only. Flag indicates if user is in PayG model
&quot;tenantProjectId&quot;: &quot;A String&quot;, # Output only. Tenant project id of the consumer project.
&quot;vpcsc&quot;: True or False, # Optional. Flag indicates whether vpc-sc is enabled.
}

updateMask: string, Required. The list of fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
&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.
&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.
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&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.
},
&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.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&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}`.
&quot;response&quot;: { # The normal response of the operation in case of success. 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`.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>

</body></html>
Expand Up @@ -116,6 +116,17 @@ <h3>Method Details</h3>
&quot;description&quot;: &quot;A String&quot;, # Output only. Description of the resource.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. Display name.
&quot;documentationUri&quot;: &quot;A String&quot;, # Output only. Link to documentation page.
&quot;eventingDetails&quot;: { # Eventing Details message. # Output only. Eventing details. Will be null if eventing is not supported.
&quot;customEventTypes&quot;: True or False, # Output only. Custom Event Types.
&quot;description&quot;: &quot;A String&quot;, # Output only. Description.
&quot;documentationLink&quot;: &quot;A String&quot;, # Output only. Link to public documentation.
&quot;iconLocation&quot;: &quot;A String&quot;, # Output only. Cloud storage location of the icon.
&quot;launchStage&quot;: &quot;A String&quot;, # Output only. Eventing Launch Stage.
&quot;name&quot;: &quot;A String&quot;, # Output only. Name of the Eventing trigger.
&quot;searchTags&quot;: [ # Output only. Array of search keywords.
&quot;A String&quot;,
],
},
&quot;externalUri&quot;: &quot;A String&quot;, # Output only. Link to external page.
&quot;labels&quot;: { # Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
&quot;a_key&quot;: &quot;A String&quot;,
Expand Down Expand Up @@ -151,6 +162,17 @@ <h3>Method Details</h3>
&quot;description&quot;: &quot;A String&quot;, # Output only. Description of the resource.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. Display name.
&quot;documentationUri&quot;: &quot;A String&quot;, # Output only. Link to documentation page.
&quot;eventingDetails&quot;: { # Eventing Details message. # Output only. Eventing details. Will be null if eventing is not supported.
&quot;customEventTypes&quot;: True or False, # Output only. Custom Event Types.
&quot;description&quot;: &quot;A String&quot;, # Output only. Description.
&quot;documentationLink&quot;: &quot;A String&quot;, # Output only. Link to public documentation.
&quot;iconLocation&quot;: &quot;A String&quot;, # Output only. Cloud storage location of the icon.
&quot;launchStage&quot;: &quot;A String&quot;, # Output only. Eventing Launch Stage.
&quot;name&quot;: &quot;A String&quot;, # Output only. Name of the Eventing trigger.
&quot;searchTags&quot;: [ # Output only. Array of search keywords.
&quot;A String&quot;,
],
},
&quot;externalUri&quot;: &quot;A String&quot;, # Output only. Link to external page.
&quot;labels&quot;: { # Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
&quot;a_key&quot;: &quot;A String&quot;,
Expand Down
@@ -0,0 +1,168 @@
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}

body {
font-size: 13px;
padding: 1em;
}

h1 {
font-size: 26px;
margin-bottom: 1em;
}

h2 {
font-size: 24px;
margin-bottom: 1em;
}

h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}

pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
margin-top: 0.5em;
}

h1, h2, h3, p {
font-family: Arial, sans serif;
}

h1, h2, h3 {
border-bottom: solid #CCC 1px;
}

.toc_element {
margin-top: 0.5em;
}

.firstline {
margin-left: 2 em;
}

.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}

.details {
font-weight: bold;
font-size: 14px;
}

</style>

<h1><a href="connectors_v1.html">Connectors API</a> . <a href="connectors_v1.projects.html">projects</a> . <a href="connectors_v1.projects.locations.html">locations</a> . <a href="connectors_v1.projects.locations.providers.html">providers</a> . <a href="connectors_v1.projects.locations.providers.connectors.html">connectors</a> . <a href="connectors_v1.projects.locations.providers.connectors.versions.html">versions</a> . <a href="connectors_v1.projects.locations.providers.connectors.versions.eventtypes.html">eventtypes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single event type.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Event Types in a given Connector Version.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>

<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single event type.

Args:
name: string, Required. Resource name of the form: `projects/*/locations/*/providers/*/connectors/*/versions/*/eventtypes/*` Only global location is supported for EventType resource. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # EventType includes fields.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Created time.
&quot;enrichedEventPayloadSchema&quot;: &quot;A String&quot;, # Output only. Schema of the event payload after enriched. Will be null if read before send is not supported.
&quot;entityType&quot;: &quot;A String&quot;, # Output only. Runtime entity type name. Will be null if entity type map is not available. Used for read before send feature.
&quot;eventPayloadSchema&quot;: &quot;A String&quot;, # Output only. Schema of webhook event payload.
&quot;eventTypeId&quot;: &quot;A String&quot;, # Output only. Event type id. Example: `ticket.created`.
&quot;idPath&quot;: &quot;A String&quot;, # Output only. Id path denotes the path of id in webhook payload.
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the eventtype. Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version}/eventtypes/{eventtype} Only global location is supported for Connector resource.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
}</pre>
</div>

<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Event Types in a given Connector Version.

Args:
parent: string, Required. Parent resource of the connectors, of the form: `projects/*/locations/*/providers/*/connectors/*/versions/*` Only global location is supported for EventType resource. (required)
pageSize: integer, Page size.
pageToken: string, Page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response message for Connectors.ListEventTypes.
&quot;eventTypes&quot;: [ # A list of connector versions.
{ # EventType includes fields.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Created time.
&quot;enrichedEventPayloadSchema&quot;: &quot;A String&quot;, # Output only. Schema of the event payload after enriched. Will be null if read before send is not supported.
&quot;entityType&quot;: &quot;A String&quot;, # Output only. Runtime entity type name. Will be null if entity type map is not available. Used for read before send feature.
&quot;eventPayloadSchema&quot;: &quot;A String&quot;, # Output only. Schema of webhook event payload.
&quot;eventTypeId&quot;: &quot;A String&quot;, # Output only. Event type id. Example: `ticket.created`.
&quot;idPath&quot;: &quot;A String&quot;, # Output only. Id path denotes the path of id in webhook payload.
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the eventtype. Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version}/eventtypes/{eventtype} Only global location is supported for Connector resource.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # Next page token.
}</pre>
</div>

<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.

Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)

Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>

</body></html>

0 comments on commit 665f278

Please sign in to comment.