Class ApiKeyCreateParams
-
- All Implemented Interfaces:
-
com.braintrustdata.api.core.Params
public final class ApiKeyCreateParams implements Params
Create a new api_key. It is possible to have multiple API keys with the same name. There is no de-duplication
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classApiKeyCreateParams.BuilderA builder for ApiKeyCreateParams.
public final classApiKeyCreateParams.Body
-
Method Summary
Modifier and Type Method Description final Stringname()Name of the api key. final Optional<String>orgName()For nearly all users, this parameter should be unnecessary. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<String>_orgName()Returns the raw JSON value of orgName. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()final ApiKeyCreateParams.BuildertoBuilder()final ApiKeyCreateParams.Body_body()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. Booleanequals(Object other)IntegerhashCode()StringtoString()final static ApiKeyCreateParams.Builderbuilder()Returns a mutable builder for constructing an instance of ApiKeyCreateParams. -
-
Method Detail
-
orgName
final Optional<String> orgName()
For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, you may specify the name of the organization the API key belongs in.
-
_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.
-
_orgName
final JsonField<String> _orgName()
Returns the raw JSON value of orgName.
Unlike orgName, 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()
-
toBuilder
final ApiKeyCreateParams.Builder toBuilder()
-
_body
final ApiKeyCreateParams.Body _body()
-
_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.
-
builder
final static ApiKeyCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of ApiKeyCreateParams.
The following fields are required:
.name()
-
-
-
-