Debian Codegraph @

docs/dyn/apphub_v1.projects.locations.serviceProjectAttachments.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="apphub_v1.html">App Hub API</a> . <a href="apphub_v1.projects.html">projects</a> . <a href="apphub_v1.projects.locations.html">locations</a> . <a href="apphub_v1.projects.locations.serviceProjectAttachments.html">serviceProjectAttachments</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(parent, body=None, requestId=None, serviceProjectAttachmentId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Attaches a service project to the host project.</p>
83 <p class="toc_element">
84 <code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Deletes a service project attachment.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88 <p class="firstline">Gets a service project attachment.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Lists service projects attached to the host project.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <h3>Method Details</h3>
96 <div class="method">
97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99 </div>
100
101 <div class="method">
102 <code class="details" id="create">create(parent, body=None, requestId=None, serviceProjectAttachmentId=None, x__xgafv=None)</code>
103 <pre>Attaches a service project to the host project.
104
105 Args:
106 parent: string, Required. Host project ID and location to which service project is being attached. Only global location is supported. Expected format: `projects/{project}/locations/{location}`. (required)
107 body: object, The request body.
108 The object takes the form of:
109
110 { # ServiceProjectAttachment represents an attachment from a service project to a host project. Service projects contain the underlying cloud infrastructure resources, and expose these resources to the host project through a ServiceProjectAttachment. With the attachments, the host project can provide an aggregated view of resources across all service projects.
111 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time.
112 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of a ServiceProjectAttachment. Format: `&quot;projects/{host-project-id}/locations/global/serviceProjectAttachments/{service-project-id}.&quot;`
113 &quot;serviceProject&quot;: &quot;A String&quot;, # Required. Immutable. Service project name in the format: `&quot;projects/abc&quot;` or `&quot;projects/123&quot;`. As input, project name with either project id or number are accepted. As output, this field will contain project number.
114 &quot;state&quot;: &quot;A String&quot;, # Output only. ServiceProjectAttachment state.
115 &quot;uid&quot;: &quot;A String&quot;, # Output only. A globally unique identifier (in UUID4 format) for the `ServiceProjectAttachment`.
116 }
117
118 requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
119 serviceProjectAttachmentId: string, Required. The service project attachment identifier must contain the project id of the service project specified in the service_project_attachment.service_project field.
120 x__xgafv: string, V1 error format.
121 Allowed values
122 1 - v1 error format
123 2 - v2 error format
124
125 Returns:
126 An object of the form:
127
128 { # This resource represents a long-running operation that is the result of a network API call.
129 &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.
130 &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.
131 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
132 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
133 {
134 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
135 },
136 ],
137 &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.
138 },
139 &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.
140 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
141 },
142 &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}`.
143 &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`.
144 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
145 },
146 }</pre>
147 </div>
148
149 <div class="method">
150 <code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code>
151 <pre>Deletes a service project attachment.
152
153 Args:
154 name: string, Required. Fully qualified name of the service project attachment to delete. Expected format: `projects/{project}/locations/{location}/serviceProjectAttachments/{serviceProjectAttachment}`. (required)
155 requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
156 x__xgafv: string, V1 error format.
157 Allowed values
158 1 - v1 error format
159 2 - v2 error format
160
161 Returns:
162 An object of the form:
163
164 { # This resource represents a long-running operation that is the result of a network API call.
165 &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.
166 &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.
167 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
168 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
169 {
170 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
171 },
172 ],
173 &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.
174 },
175 &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.
176 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
177 },
178 &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}`.
179 &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`.
180 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
181 },
182 }</pre>
183 </div>
184
185 <div class="method">
186 <code class="details" id="get">get(name, x__xgafv=None)</code>
187 <pre>Gets a service project attachment.
188
189 Args:
190 name: string, Required. Fully qualified name of the service project attachment to retrieve. Expected format: `projects/{project}/locations/{location}/serviceProjectAttachments/{serviceProjectAttachment}`. (required)
191 x__xgafv: string, V1 error format.
192 Allowed values
193 1 - v1 error format
194 2 - v2 error format
195
196 Returns:
197 An object of the form:
198
199 { # ServiceProjectAttachment represents an attachment from a service project to a host project. Service projects contain the underlying cloud infrastructure resources, and expose these resources to the host project through a ServiceProjectAttachment. With the attachments, the host project can provide an aggregated view of resources across all service projects.
200 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time.
201 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of a ServiceProjectAttachment. Format: `&quot;projects/{host-project-id}/locations/global/serviceProjectAttachments/{service-project-id}.&quot;`
202 &quot;serviceProject&quot;: &quot;A String&quot;, # Required. Immutable. Service project name in the format: `&quot;projects/abc&quot;` or `&quot;projects/123&quot;`. As input, project name with either project id or number are accepted. As output, this field will contain project number.
203 &quot;state&quot;: &quot;A String&quot;, # Output only. ServiceProjectAttachment state.
204 &quot;uid&quot;: &quot;A String&quot;, # Output only. A globally unique identifier (in UUID4 format) for the `ServiceProjectAttachment`.
205 }</pre>
206 </div>
207
208 <div class="method">
209 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
210 <pre>Lists service projects attached to the host project.
211
212 Args:
213 parent: string, Required. Host project ID and location to list service project attachments. Only global location is supported. Expected format: `projects/{project}/locations/{location}`. (required)
214 filter: string, Optional. Filtering results.
215 orderBy: string, Optional. Hint for how to order the results.
216 pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
217 pageToken: string, Optional. A token identifying a page of results the server should return.
218 x__xgafv: string, V1 error format.
219 Allowed values
220 1 - v1 error format
221 2 - v2 error format
222
223 Returns:
224 An object of the form:
225
226 { # Response for ListServiceProjectAttachments.
227 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying a page of results the server should return.
228 &quot;serviceProjectAttachments&quot;: [ # List of service project attachments.
229 { # ServiceProjectAttachment represents an attachment from a service project to a host project. Service projects contain the underlying cloud infrastructure resources, and expose these resources to the host project through a ServiceProjectAttachment. With the attachments, the host project can provide an aggregated view of resources across all service projects.
230 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time.
231 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of a ServiceProjectAttachment. Format: `&quot;projects/{host-project-id}/locations/global/serviceProjectAttachments/{service-project-id}.&quot;`
232 &quot;serviceProject&quot;: &quot;A String&quot;, # Required. Immutable. Service project name in the format: `&quot;projects/abc&quot;` or `&quot;projects/123&quot;`. As input, project name with either project id or number are accepted. As output, this field will contain project number.
233 &quot;state&quot;: &quot;A String&quot;, # Output only. ServiceProjectAttachment state.
234 &quot;uid&quot;: &quot;A String&quot;, # Output only. A globally unique identifier (in UUID4 format) for the `ServiceProjectAttachment`.
235 },
236 ],
237 &quot;unreachable&quot;: [ # Locations that could not be reached.
238 &quot;A String&quot;,
239 ],
240 }</pre>
241 </div>
242
243 <div class="method">
244 <code class="details" id="list_next">list_next()</code>
245 <pre>Retrieves the next page of results.
246
247 Args:
248 previous_request: The request for the previous page. (required)
249 previous_response: The response from the request for the previous page. (required)
250
251 Returns:
252 A request object that you can call &#x27;execute()&#x27; on to request the next
253 page. Returns None if there are no more items in the collection.
254 </pre>
255 </div>
256
257 </body></html>