blob: 69359b0504fefb69eb784d85e3f694246299b0ff [file] [log] [blame]
<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="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.environments.html">environments</a> . <a href="apigee_v1.organizations.environments.resourcefiles.html">resourcefiles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, name=None, type=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a resource file.</p>
<p class="toc_element">
<code><a href="#delete">delete(parent, type, name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a resource file.</p>
<p class="toc_element">
<code><a href="#get">get(parent, type, name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the contents of a resource file.</p>
<p class="toc_element">
<code><a href="#list">list(parent, type=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all resource files.</p>
<p class="toc_element">
<code><a href="#listEnvironmentResources">listEnvironmentResources(parent, type, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all resource files.</p>
<p class="toc_element">
<code><a href="#update">update(parent, type, name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a resource file.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent, body=None, name=None, type=None, x__xgafv=None)</code>
<pre>Creates a resource file.
Specify the `Content-Type` as `application/octet-stream` or
`multipart/form-data`.
For more information about resource files, see
[Resource files](/api-platform/develop/resource-files).
Args:
parent: string, Required. Name of the environment in which to create the resource file in the
following format:
`organizations/{org}/environments/{env}`. (required)
body: object, The request body.
The object takes the form of:
{ # Message that represents an arbitrary HTTP body. It should only be used for
# payload formats that can&#x27;t be represented as JSON, such as raw binary or
# an HTML page.
#
#
# This message can be used both in streaming and non-streaming API methods in
# the request as well as the response.
#
# It can be used as a top-level request field, which is convenient if one
# wants to extract parameters from either the URL or HTTP template into the
# request fields and also want access to the raw HTTP body.
#
# Example:
#
# message GetResourceRequest {
# // A unique request id.
# string request_id = 1;
#
# // The raw HTTP body is bound to this field.
# google.api.HttpBody http_body = 2;
# }
#
# service ResourceService {
# rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
# rpc UpdateResource(google.api.HttpBody) returns
# (google.protobuf.Empty);
# }
#
# Example with streaming methods:
#
# service CaldavService {
# rpc GetCalendar(stream google.api.HttpBody)
# returns (stream google.api.HttpBody);
# rpc UpdateCalendar(stream google.api.HttpBody)
# returns (stream google.api.HttpBody);
# }
#
# Use of this type only changes how the request and response bodies are
# handled, all other features will continue to work unchanged.
&quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
&quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
&quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response
# for streaming APIs.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
}
name: string, Required. Name of the resource file. Must match the regular expression:
&lt;var&gt;[a-zA-Z0-9:/\\!@#$%^&amp;{}\[\]()+\-=,.~&#x27;` ]{1,255}&lt;/var&gt;
type: string, Required. Resource file type. {{ resource_file_type }}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Metadata about a resource file.
&quot;type&quot;: &quot;A String&quot;, # Resource file type. {{ resource_file_type }}
&quot;name&quot;: &quot;A String&quot;, # ID of the resource file.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(parent, type, name, x__xgafv=None)</code>
<pre>Deletes a resource file.
For more information about resource files, see
[Resource files](/api-platform/develop/resource-files).
Args:
parent: string, Required. Name of the environment in the following format:
`organizations/{org}/environments/{env}`. (required)
type: string, Required. Resource file type. {{ resource_file_type }} (required)
name: string, Required. ID of the resource file to delete. Must match the regular
expression: &lt;var&gt;[a-zA-Z0-9:/\\!@#$%^&amp;{}\[\]()+\-=,.~&#x27;` ]{1,255}&lt;/var&gt; (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Metadata about a resource file.
&quot;type&quot;: &quot;A String&quot;, # Resource file type. {{ resource_file_type }}
&quot;name&quot;: &quot;A String&quot;, # ID of the resource file.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(parent, type, name, x__xgafv=None)</code>
<pre>Gets the contents of a resource file.
For more information about resource files, see
[Resource files](/api-platform/develop/resource-files).
Args:
parent: string, Required. Name of the environment in the following format:
`organizations/{org}/environments/{env}`. (required)
type: string, Required. Resource file type. {{ resource_file_type }} (required)
name: string, Required. ID of the resource file. Must match the regular
expression: &lt;var&gt;[a-zA-Z0-9:/\\!@#$%^&amp;{}\[\]()+\-=,.~&#x27;` ]{1,255}&lt;/var&gt; (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message that represents an arbitrary HTTP body. It should only be used for
# payload formats that can&#x27;t be represented as JSON, such as raw binary or
# an HTML page.
#
#
# This message can be used both in streaming and non-streaming API methods in
# the request as well as the response.
#
# It can be used as a top-level request field, which is convenient if one
# wants to extract parameters from either the URL or HTTP template into the
# request fields and also want access to the raw HTTP body.
#
# Example:
#
# message GetResourceRequest {
# // A unique request id.
# string request_id = 1;
#
# // The raw HTTP body is bound to this field.
# google.api.HttpBody http_body = 2;
# }
#
# service ResourceService {
# rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
# rpc UpdateResource(google.api.HttpBody) returns
# (google.protobuf.Empty);
# }
#
# Example with streaming methods:
#
# service CaldavService {
# rpc GetCalendar(stream google.api.HttpBody)
# returns (stream google.api.HttpBody);
# rpc UpdateCalendar(stream google.api.HttpBody)
# returns (stream google.api.HttpBody);
# }
#
# Use of this type only changes how the request and response bodies are
# handled, all other features will continue to work unchanged.
&quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
&quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
&quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response
# for streaming APIs.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, type=None, x__xgafv=None)</code>
<pre>Lists all resource files.
For more information about resource files, see
[Resource files](/api-platform/develop/resource-files).
Args:
parent: string, Required. Name of the environment in which to list resource files in the following
format:
`organizations/{org}/environments/{env}`. (required)
type: string, Optional. Type of resource files to list.
{{ resource_file_type }}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for
# ListEnvironmentResources
&quot;resourceFile&quot;: [ # List of resources files.
{ # Metadata about a resource file.
&quot;type&quot;: &quot;A String&quot;, # Resource file type. {{ resource_file_type }}
&quot;name&quot;: &quot;A String&quot;, # ID of the resource file.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="listEnvironmentResources">listEnvironmentResources(parent, type, x__xgafv=None)</code>
<pre>Lists all resource files.
For more information about resource files, see
[Resource files](/api-platform/develop/resource-files).
Args:
parent: string, Required. Name of the environment in which to list resource files in the following
format:
`organizations/{org}/environments/{env}`. (required)
type: string, Optional. Type of resource files to list.
{{ resource_file_type }} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for
# ListEnvironmentResources
&quot;resourceFile&quot;: [ # List of resources files.
{ # Metadata about a resource file.
&quot;type&quot;: &quot;A String&quot;, # Resource file type. {{ resource_file_type }}
&quot;name&quot;: &quot;A String&quot;, # ID of the resource file.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(parent, type, name, body=None, x__xgafv=None)</code>
<pre>Updates a resource file.
Specify the `Content-Type` as `application/octet-stream` or
`multipart/form-data`.
For more information about resource files, see
[Resource files](/api-platform/develop/resource-files).
Args:
parent: string, Required. Name of the environment in the following format:
`organizations/{org}/environments/{env}`. (required)
type: string, Required. Resource file type. {{ resource_file_type }} (required)
name: string, Required. ID of the resource file to update. Must match the regular
expression: &lt;var&gt;[a-zA-Z0-9:/\\!@#$%^&amp;{}\[\]()+\-=,.~&#x27;` ]{1,255}&lt;/var&gt; (required)
body: object, The request body.
The object takes the form of:
{ # Message that represents an arbitrary HTTP body. It should only be used for
# payload formats that can&#x27;t be represented as JSON, such as raw binary or
# an HTML page.
#
#
# This message can be used both in streaming and non-streaming API methods in
# the request as well as the response.
#
# It can be used as a top-level request field, which is convenient if one
# wants to extract parameters from either the URL or HTTP template into the
# request fields and also want access to the raw HTTP body.
#
# Example:
#
# message GetResourceRequest {
# // A unique request id.
# string request_id = 1;
#
# // The raw HTTP body is bound to this field.
# google.api.HttpBody http_body = 2;
# }
#
# service ResourceService {
# rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
# rpc UpdateResource(google.api.HttpBody) returns
# (google.protobuf.Empty);
# }
#
# Example with streaming methods:
#
# service CaldavService {
# rpc GetCalendar(stream google.api.HttpBody)
# returns (stream google.api.HttpBody);
# rpc UpdateCalendar(stream google.api.HttpBody)
# returns (stream google.api.HttpBody);
# }
#
# Use of this type only changes how the request and response bodies are
# handled, all other features will continue to work unchanged.
&quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
&quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
&quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response
# for streaming APIs.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Metadata about a resource file.
&quot;type&quot;: &quot;A String&quot;, # Resource file type. {{ resource_file_type }}
&quot;name&quot;: &quot;A String&quot;, # ID of the resource file.
}</pre>
</div>
</body></html>