Class UploadStartParams
-
- All Implemented Interfaces:
-
com.hiddenlayer.api.core.Params
public final class UploadStartParams implements Params
Start a model upload
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classUploadStartParams.BuilderA builder for UploadStartParams.
public final classUploadStartParams.Bodypublic final classUploadStartParams.RequestSourceIdentifies the system that requested the scan
-
Method Summary
Modifier and Type Method Description final Optional<String>xCorrelationId()final StringmodelName()Model name final StringmodelVersion()Model version final StringrequestingEntity()Requesting entity final Optional<String>locationAlias()Requested location alias final Optional<String>origin()Specifies the platform or service where the model originated before being scanned final Optional<UploadStartParams.RequestSource>requestSource()Identifies the system that requested the scan final JsonField<String>_modelName()Returns the raw JSON value of modelName. final JsonField<String>_modelVersion()Returns the raw JSON value of modelVersion. final JsonField<String>_requestingEntity()Returns the raw JSON value of requestingEntity. final JsonField<String>_locationAlias()Returns the raw JSON value of locationAlias. final JsonField<String>_origin()Returns the raw JSON value of origin. final JsonField<UploadStartParams.RequestSource>_requestSource()Returns the raw JSON value of requestSource. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final UploadStartParams.BuildertoBuilder()final UploadStartParams.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 UploadStartParams.Builderbuilder()Returns a mutable builder for constructing an instance of UploadStartParams. -
-
Method Detail
-
xCorrelationId
final Optional<String> xCorrelationId()
-
modelVersion
final String modelVersion()
Model version
-
requestingEntity
final String requestingEntity()
Requesting entity
-
locationAlias
final Optional<String> locationAlias()
Requested location alias
-
origin
final Optional<String> origin()
Specifies the platform or service where the model originated before being scanned
-
requestSource
final Optional<UploadStartParams.RequestSource> requestSource()
Identifies the system that requested the scan
-
_modelName
final JsonField<String> _modelName()
Returns the raw JSON value of modelName.
Unlike modelName, this method doesn't throw if the JSON field has an unexpected type.
-
_modelVersion
final JsonField<String> _modelVersion()
Returns the raw JSON value of modelVersion.
Unlike modelVersion, this method doesn't throw if the JSON field has an unexpected type.
-
_requestingEntity
final JsonField<String> _requestingEntity()
Returns the raw JSON value of requestingEntity.
Unlike requestingEntity, this method doesn't throw if the JSON field has an unexpected type.
-
_locationAlias
final JsonField<String> _locationAlias()
Returns the raw JSON value of locationAlias.
Unlike locationAlias, this method doesn't throw if the JSON field has an unexpected type.
-
_origin
final JsonField<String> _origin()
Returns the raw JSON value of origin.
Unlike origin, this method doesn't throw if the JSON field has an unexpected type.
-
_requestSource
final JsonField<UploadStartParams.RequestSource> _requestSource()
Returns the raw JSON value of requestSource.
Unlike requestSource, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final UploadStartParams.Builder toBuilder()
-
_body
final UploadStartParams.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 UploadStartParams.Builder builder()
Returns a mutable builder for constructing an instance of UploadStartParams.
The following fields are required:
.modelName() .modelVersion() .requestingEntity()
-
-
-
-