Class SpanIframeUpdateParams
-
- All Implemented Interfaces:
-
com.braintrustdata.api.core.Params
public final class SpanIframeUpdateParams implements Params
Partially update a span_iframe object. Specify the fields to update in the payload. Any object-type fields will be deep-merged with existing content. Currently we do not support removing fields or setting them to null.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classSpanIframeUpdateParams.Bodypublic final classSpanIframeUpdateParams.BuilderA builder for SpanIframeUpdateParams.
-
Method Summary
Modifier and Type Method Description final StringspanIframeId()SpanIframe id final Optional<String>description()Textual description of the span iframe final Optional<String>name()Name of the span iframe final Optional<Boolean>postMessage()Whether to post messages to the iframe containing the span's data. final Optional<String>url()URL to embed the project viewer in an iframe final JsonField<String>_description()Returns the raw JSON value of description. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<Boolean>_postMessage()Returns the raw JSON value of postMessage. final JsonField<String>_url()Returns the raw JSON value of url. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. final StringgetPathParam(Integer index)final SpanIframeUpdateParams.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static SpanIframeUpdateParams.Builderbuilder()Returns a mutable builder for constructing an instance of SpanIframeUpdateParams. -
-
Method Detail
-
spanIframeId
final String spanIframeId()
SpanIframe id
-
description
final Optional<String> description()
Textual description of the span iframe
-
postMessage
final Optional<Boolean> postMessage()
Whether to post messages to the iframe containing the span's data. This is useful when you want to render more data than fits in the URL.
-
_description
final JsonField<String> _description()
Returns the raw JSON value of description.
Unlike description, this method doesn't throw if the JSON field has an unexpected type.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_postMessage
final JsonField<Boolean> _postMessage()
Returns the raw JSON value of postMessage.
Unlike postMessage, this method doesn't throw if the JSON field has an unexpected type.
-
_url
final JsonField<String> _url()
Returns the raw JSON value of url.
Unlike url, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
getPathParam
final String getPathParam(Integer index)
-
toBuilder
final SpanIframeUpdateParams.Builder toBuilder()
-
builder
final static SpanIframeUpdateParams.Builder builder()
Returns a mutable builder for constructing an instance of SpanIframeUpdateParams.
The following fields are required:
.spanIframeId()
-
-
-
-