ApiArgs

data class ApiArgs(val action: Output<String>? = null, val contentType: Output<String>? = null, val data: Output<String>? = null, val extensions: Output<List<Map<String, String>>>? = null, val file: Output<AssetOrArchive>? = null, val name: Output<String>? = null, val organizationId: Output<String>? = null, val validate: Output<Boolean>? = null) : ConvertibleToJava<ApiArgs>

Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the name query parameter to the name of the API proxy. Import an API proxy configuration bundle stored in zip format on your local machine to your organization by doing the following: * Set the name query parameter to the name of the API proxy. * Set the action query parameter to import. * Set the Content-Type header to multipart/form-data. * Pass as a file the name of API proxy configuration bundle stored in zip format on your local machine using the file form field. Note: To validate the API proxy configuration bundle only without importing it, set the action query parameter to validate. When importing an API proxy configuration bundle, if the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client.

Constructors

Link copied to clipboard
fun ApiArgs(action: Output<String>? = null, contentType: Output<String>? = null, data: Output<String>? = null, extensions: Output<List<Map<String, String>>>? = null, file: Output<AssetOrArchive>? = null, name: Output<String>? = null, organizationId: Output<String>? = null, validate: Output<Boolean>? = null)

Functions

Link copied to clipboard
open override fun toJava(): ApiArgs

Properties

Link copied to clipboard
val action: Output<String>? = null

Action to perform when importing an API proxy configuration bundle. Set this parameter to one of the following values: * import to import the API proxy configuration bundle. * validate to validate the API proxy configuration bundle without importing it.

Link copied to clipboard
val contentType: Output<String>? = null

The HTTP Content-Type header value specifying the content type of the body.

Link copied to clipboard
val data: Output<String>? = null

The HTTP request/response body as raw binary.

Link copied to clipboard
val extensions: Output<List<Map<String, String>>>? = null

Application specific response metadata. Must be set in the first response for streaming APIs.

Link copied to clipboard
val file: Output<AssetOrArchive>? = null

File to upload.

Link copied to clipboard
val name: Output<String>? = null

Name of the API proxy. Restrict the characters used to: A-Za-z0-9._-

Link copied to clipboard
val organizationId: Output<String>? = null
Link copied to clipboard
val validate: Output<Boolean>? = null

Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.