1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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="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> 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, name=None, type=None, x__xgafv=None)</a></code></p> 82<p class="firstline">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](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files).</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(parent, type, name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a resource file. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files).</p> 86<p class="toc_element"> 87 <code><a href="#get">get(parent, type, name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets the contents of a resource file. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files).</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, type=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists all resource files, optionally filtering by type. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files).</p> 92<p class="toc_element"> 93 <code><a href="#listEnvironmentResources">listEnvironmentResources(parent, type, x__xgafv=None)</a></code></p> 94<p class="firstline">Lists all resource files, optionally filtering by type. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files).</p> 95<p class="toc_element"> 96 <code><a href="#update">update(parent, type, name, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">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](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files).</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="create">create(parent, body=None, name=None, type=None, x__xgafv=None)</code> 106 <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](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). 107 108Args: 109 parent: string, Required. Name of the environment in which to create the resource file in the following format: `organizations/{org}/environments/{env}`. (required) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can'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. 114 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 115 "data": "A String", # The HTTP request/response body as raw binary. 116 "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs. 117 { 118 "a_key": "", # Properties of the object. Contains field @type with type URL. 119 }, 120 ], 121} 122 123 name: string, Required. Name of the resource file. Must match the regular expression: [a-zA-Z0-9:/\\!@#$%^&{}\[\]()+\-=,.~'` ]{1,255} 124 type: string, Required. Resource file type. {{ resource_file_type }} 125 x__xgafv: string, V1 error format. 126 Allowed values 127 1 - v1 error format 128 2 - v2 error format 129 130Returns: 131 An object of the form: 132 133 { # Metadata about a resource file. 134 "name": "A String", # ID of the resource file. 135 "type": "A String", # Resource file type. {{ resource_file_type }} 136}</pre> 137</div> 138 139<div class="method"> 140 <code class="details" id="delete">delete(parent, type, name, x__xgafv=None)</code> 141 <pre>Deletes a resource file. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). 142 143Args: 144 parent: string, Required. Name of the environment in the following format: `organizations/{org}/environments/{env}`. (required) 145 type: string, Required. Resource file type. {{ resource_file_type }} (required) 146 name: string, Required. ID of the resource file to delete. Must match the regular expression: [a-zA-Z0-9:/\\!@#$%^&{}\[\]()+\-=,.~'` ]{1,255} (required) 147 x__xgafv: string, V1 error format. 148 Allowed values 149 1 - v1 error format 150 2 - v2 error format 151 152Returns: 153 An object of the form: 154 155 { # Metadata about a resource file. 156 "name": "A String", # ID of the resource file. 157 "type": "A String", # Resource file type. {{ resource_file_type }} 158}</pre> 159</div> 160 161<div class="method"> 162 <code class="details" id="get">get(parent, type, name, x__xgafv=None)</code> 163 <pre>Gets the contents of a resource file. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). 164 165Args: 166 parent: string, Required. Name of the environment in the following format: `organizations/{org}/environments/{env}`. (required) 167 type: string, Required. Resource file type. {{ resource_file_type }} (required) 168 name: string, Required. ID of the resource file. Must match the regular expression: [a-zA-Z0-9:/\\!@#$%^&{}\[\]()+\-=,.~'` ]{1,255} (required) 169 x__xgafv: string, V1 error format. 170 Allowed values 171 1 - v1 error format 172 2 - v2 error format 173 174Returns: 175 An object of the form: 176 177 { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can'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. 178 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 179 "data": "A String", # The HTTP request/response body as raw binary. 180 "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs. 181 { 182 "a_key": "", # Properties of the object. Contains field @type with type URL. 183 }, 184 ], 185}</pre> 186</div> 187 188<div class="method"> 189 <code class="details" id="list">list(parent, type=None, x__xgafv=None)</code> 190 <pre>Lists all resource files, optionally filtering by type. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). 191 192Args: 193 parent: string, Required. Name of the environment in which to list resource files in the following format: `organizations/{org}/environments/{env}`. (required) 194 type: string, Optional. Type of resource files to list. {{ resource_file_type }} 195 x__xgafv: string, V1 error format. 196 Allowed values 197 1 - v1 error format 198 2 - v2 error format 199 200Returns: 201 An object of the form: 202 203 { # Response for ListEnvironmentResources 204 "resourceFile": [ # List of resources files. 205 { # Metadata about a resource file. 206 "name": "A String", # ID of the resource file. 207 "type": "A String", # Resource file type. {{ resource_file_type }} 208 }, 209 ], 210}</pre> 211</div> 212 213<div class="method"> 214 <code class="details" id="listEnvironmentResources">listEnvironmentResources(parent, type, x__xgafv=None)</code> 215 <pre>Lists all resource files, optionally filtering by type. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). 216 217Args: 218 parent: string, Required. Name of the environment in which to list resource files in the following format: `organizations/{org}/environments/{env}`. (required) 219 type: string, Optional. Type of resource files to list. {{ resource_file_type }} (required) 220 x__xgafv: string, V1 error format. 221 Allowed values 222 1 - v1 error format 223 2 - v2 error format 224 225Returns: 226 An object of the form: 227 228 { # Response for ListEnvironmentResources 229 "resourceFile": [ # List of resources files. 230 { # Metadata about a resource file. 231 "name": "A String", # ID of the resource file. 232 "type": "A String", # Resource file type. {{ resource_file_type }} 233 }, 234 ], 235}</pre> 236</div> 237 238<div class="method"> 239 <code class="details" id="update">update(parent, type, name, body=None, x__xgafv=None)</code> 240 <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](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). 241 242Args: 243 parent: string, Required. Name of the environment in the following format: `organizations/{org}/environments/{env}`. (required) 244 type: string, Required. Resource file type. {{ resource_file_type }} (required) 245 name: string, Required. ID of the resource file to update. Must match the regular expression: [a-zA-Z0-9:/\\!@#$%^&{}\[\]()+\-=,.~'` ]{1,255} (required) 246 body: object, The request body. 247 The object takes the form of: 248 249{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can'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. 250 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 251 "data": "A String", # The HTTP request/response body as raw binary. 252 "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs. 253 { 254 "a_key": "", # Properties of the object. Contains field @type with type URL. 255 }, 256 ], 257} 258 259 x__xgafv: string, V1 error format. 260 Allowed values 261 1 - v1 error format 262 2 - v2 error format 263 264Returns: 265 An object of the form: 266 267 { # Metadata about a resource file. 268 "name": "A String", # ID of the resource file. 269 "type": "A String", # Resource file type. {{ resource_file_type }} 270}</pre> 271</div> 272 273</body></html>