File: connectors_v1.projects.locations.providers.connectors.html

package info (click to toggle)
python-googleapi 2.187.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 562,316 kB
  • sloc: python: 11,087; javascript: 249; sh: 114; makefile: 59
file content (231 lines) | stat: -rw-r--r-- 10,388 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
<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></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="connectors_v1.projects.locations.providers.connectors.versions.html">versions()</a></code>
</p>
<p class="firstline">Returns the versions Resource.</p>

<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 Connector.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Connectors in a given project and location.</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 Connector.

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

Returns:
  An object of the form:

    { # Connectors indicates a specific connector type, e.x. Salesforce, SAP etc.
  &quot;category&quot;: &quot;A String&quot;, # Output only. Category of the connector.
  &quot;connectorType&quot;: &quot;A String&quot;, # Output only. The type of the connector.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Created time.
  &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;type&quot;: &quot;A String&quot;, # Output only. The type of the event listener for a specific connector.
  },
  &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;,
  },
  &quot;launchStage&quot;: &quot;A String&quot;, # Output only. Flag to mark the version indicating the launch stage.
  &quot;marketplaceConnectorDetails&quot;: { # Marketplace connector details. # Output only. Marketplace connector details. Will be null if the connector is not marketplace connector.
    &quot;marketplaceProduct&quot;: &quot;A String&quot;, # Marketplace product name.
    &quot;marketplaceProductId&quot;: &quot;A String&quot;, # Marketplace product ID.
    &quot;marketplaceProductUri&quot;: &quot;A String&quot;, # Marketplace product URL.
    &quot;partner&quot;: &quot;A String&quot;, # The name of the partner.
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the Connector. Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector} Only global location is supported for Connector resource.
  &quot;tags&quot;: [ # Output only. Tags of the connector.
    &quot;A String&quot;,
  ],
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
  &quot;webAssetsLocation&quot;: &quot;A String&quot;, # Output only. Cloud storage location of icons etc consumed by UI.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists Connectors in a given project and location.

Args:
  parent: string, Required. Parent resource of the connectors, of the form: `projects/*/locations/*/providers/*` Only global location is supported for Connector resource. (required)
  filter: string, Filter string.
  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.ListConnectors.
  &quot;connectors&quot;: [ # A list of connectors.
    { # Connectors indicates a specific connector type, e.x. Salesforce, SAP etc.
      &quot;category&quot;: &quot;A String&quot;, # Output only. Category of the connector.
      &quot;connectorType&quot;: &quot;A String&quot;, # Output only. The type of the connector.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Created time.
      &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;type&quot;: &quot;A String&quot;, # Output only. The type of the event listener for a specific connector.
      },
      &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;,
      },
      &quot;launchStage&quot;: &quot;A String&quot;, # Output only. Flag to mark the version indicating the launch stage.
      &quot;marketplaceConnectorDetails&quot;: { # Marketplace connector details. # Output only. Marketplace connector details. Will be null if the connector is not marketplace connector.
        &quot;marketplaceProduct&quot;: &quot;A String&quot;, # Marketplace product name.
        &quot;marketplaceProductId&quot;: &quot;A String&quot;, # Marketplace product ID.
        &quot;marketplaceProductUri&quot;: &quot;A String&quot;, # Marketplace product URL.
        &quot;partner&quot;: &quot;A String&quot;, # The name of the partner.
      },
      &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the Connector. Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector} Only global location is supported for Connector resource.
      &quot;tags&quot;: [ # Output only. Tags of the connector.
        &quot;A String&quot;,
      ],
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Updated time.
      &quot;webAssetsLocation&quot;: &quot;A String&quot;, # Output only. Cloud storage location of icons etc consumed by UI.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Next page token.
  &quot;unreachable&quot;: [ # Locations that could not be reached.
    &quot;A String&quot;,
  ],
}</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>