blob: cc1457d0858934af090232a658888c5635e07e7b [file] [log] [blame] [edit]
<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="apihub_v1.html">API hub API</a> . <a href="apihub_v1.projects.html">projects</a> . <a href="apihub_v1.projects.locations.html">locations</a> . <a href="apihub_v1.projects.locations.runtimeProjectAttachments.html">runtimeProjectAttachments</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="#create">create(parent, body=None, runtimeProjectAttachmentId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Attaches a runtime project to the host project.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a runtime project attachment in the API Hub. This call will detach the runtime project from the host project.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a runtime project attachment.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List runtime projects attached to the host project.</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="create">create(parent, body=None, runtimeProjectAttachmentId=None, x__xgafv=None)</code>
<pre>Attaches a runtime project to the host project.
Args:
parent: string, Required. The parent resource for the Runtime Project Attachment. Format: `projects/{project}/locations/{location}` (required)
body: object, The request body.
The object takes the form of:
{ # Runtime project attachment represents an attachment from the runtime project to the host project. Api Hub looks for deployments in the attached runtime projects and creates corresponding resources in Api Hub for the discovered deployments.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time.
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of a runtime project attachment. Format: &quot;projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}&quot;.
&quot;runtimeProject&quot;: &quot;A String&quot;, # Required. Immutable. Google cloud 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.
}
runtimeProjectAttachmentId: string, Required. The ID to use for the Runtime Project Attachment, which will become the final component of the Runtime Project Attachment&#x27;s name. The ID must be the same as the project ID of the Google cloud project specified in the runtime_project_attachment.runtime_project field.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Runtime project attachment represents an attachment from the runtime project to the host project. Api Hub looks for deployments in the attached runtime projects and creates corresponding resources in Api Hub for the discovered deployments.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time.
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of a runtime project attachment. Format: &quot;projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}&quot;.
&quot;runtimeProject&quot;: &quot;A String&quot;, # Required. Immutable. Google cloud 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.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Delete a runtime project attachment in the API Hub. This call will detach the runtime project from the host project.
Args:
name: string, Required. The name of the Runtime Project Attachment to delete. Format: `projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a runtime project attachment.
Args:
name: string, Required. The name of the API resource to retrieve. Format: `projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Runtime project attachment represents an attachment from the runtime project to the host project. Api Hub looks for deployments in the attached runtime projects and creates corresponding resources in Api Hub for the discovered deployments.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time.
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of a runtime project attachment. Format: &quot;projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}&quot;.
&quot;runtimeProject&quot;: &quot;A String&quot;, # Required. Immutable. Google cloud 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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List runtime projects attached to the host project.
Args:
parent: string, Required. The parent, which owns this collection of runtime project attachments. Format: `projects/{project}/locations/{location}` (required)
filter: string, Optional. An expression that filters the list of RuntimeProjectAttachments. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. All standard operators as documented at https://google.aip.dev/160 are supported. The following fields in the `RuntimeProjectAttachment` are eligible for filtering: * `name` - The name of the RuntimeProjectAttachment. * `create_time` - The time at which the RuntimeProjectAttachment was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. * `runtime_project` - The Google cloud project associated with the RuntimeProjectAttachment.
orderBy: string, Optional. Hint for how to order the results.
pageSize: integer, Optional. The maximum number of runtime project attachments to return. The service may return fewer than this value. If unspecified, at most 50 runtime project attachments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A page token, received from a previous `ListRuntimeProjectAttachments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListRuntimeProjectAttachments` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The ListRuntimeProjectAttachments method&#x27;s response.
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
&quot;runtimeProjectAttachments&quot;: [ # List of runtime project attachments.
{ # Runtime project attachment represents an attachment from the runtime project to the host project. Api Hub looks for deployments in the attached runtime projects and creates corresponding resources in Api Hub for the discovered deployments.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time.
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of a runtime project attachment. Format: &quot;projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}&quot;.
&quot;runtimeProject&quot;: &quot;A String&quot;, # Required. Immutable. Google cloud 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.
},
],
}</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>