Package com.pulumi.cloud.sdk

Class ApiRequest

java.lang.Object

com.pulumi.cloud.sdk.ApiRequest

public final class ApiRequest
extends java.lang.Object

Mutable carrier populated by a generated *Api method before it hands the request to ApiClient. Holds the HTTP verb, the templated resource path (/api/.../{param}), the categorized parameters, the request body, and the negotiated media types.

Constructor Summary

Constructors

Constructor	Description
ApiRequest(java.lang.String method, java.lang.String resourcePath)

Method Summary

Modifier and Type	Method	Description
ApiRequest	body(java.lang.Object body)
ApiRequest	consumes(java.lang.String mediaType)
ApiRequest	pathParam(java.lang.String name, java.lang.Object value)	Bind a {name} path segment.
ApiRequest	produces(java.lang.String mediaType)
ApiRequest	queryParam(java.lang.String name, java.lang.Object value)	Append a query parameter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiRequest

public ApiRequest(java.lang.String method,
                  java.lang.String resourcePath)

Method Detail

pathParam

public ApiRequest pathParam(java.lang.String name,
                            java.lang.Object value)

Bind a {name} path segment. Null values are ignored.

queryParam

public ApiRequest queryParam(java.lang.String name,
                             java.lang.Object value)

Append a query parameter. Null values are dropped; collections and arrays are emitted as repeated keys (k=a&k=b); booleans render lowercase, enums via their wire value, and dates as ISO-8601 — matching the reference clients.

body

public ApiRequest body(java.lang.Object body)

consumes

public ApiRequest consumes(java.lang.String mediaType)

produces

public ApiRequest produces(java.lang.String mediaType)