Class SpanIframeCreateParams
-
- All Implemented Interfaces:
-
com.braintrustdata.api.core.Params
public final class SpanIframeCreateParams implements Params
Create a new span_iframe. If there is an existing span_iframe with the same name as the one specified in the request, will return the existing span_iframe unmodified
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classSpanIframeCreateParams.Bodypublic final classSpanIframeCreateParams.BuilderA builder for SpanIframeCreateParams.
-
Method Summary
Modifier and Type Method Description final Stringname()Name of the span iframe final StringprojectId()Unique identifier for the project that the span iframe belongs under final Stringurl()URL to embed the project viewer in an iframe final Optional<String>description()Textual description of the span iframe final Optional<Boolean>postMessage()Whether to post messages to the iframe containing the span's data. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<String>_projectId()Returns the raw JSON value of projectId. final JsonField<String>_url()Returns the raw JSON value of url. final JsonField<String>_description()Returns the raw JSON value of description. final JsonField<Boolean>_postMessage()Returns the raw JSON value of postMessage. 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 SpanIframeCreateParams.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static SpanIframeCreateParams.Builderbuilder()Returns a mutable builder for constructing an instance of SpanIframeCreateParams. -
-
Method Detail
-
projectId
final String projectId()
Unique identifier for the project that the span iframe belongs under
-
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.
-
_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.
-
_projectId
final JsonField<String> _projectId()
Returns the raw JSON value of projectId.
Unlike projectId, 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.
-
_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.
-
_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.
-
_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.
-
toBuilder
final SpanIframeCreateParams.Builder toBuilder()
-
builder
final static SpanIframeCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of SpanIframeCreateParams.
The following fields are required:
.name() .projectId() .url()
-
-
-
-