Package com.onshape.api.requests

Class AppElementsUploadBlobSubelementRequest.Builder

java.lang.Object

com.onshape.api.requests.AppElementsUploadBlobSubelementRequest.Builder

Enclosing class:

AppElementsUploadBlobSubelementRequest

public static final class AppElementsUploadBlobSubelementRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AppElementsUploadBlobSubelementResponse	call(OnshapeDocument document, String bid)	Calls uploadBlobSubelement method, Create a blob subelement in an app element from an uploaded file.
AppElementsUploadBlobSubelementResponse	call(String bid, String did, String wid, String eid)	Calls uploadBlobSubelement method, Create a blob subelement in an app element from an uploaded file.
String	description()	Get Description of the change being made, for history tracking
AppElementsUploadBlobSubelementRequest.Builder	description(String value)	Set Description of the change being made, for history tracking
String	encodedFilename()	Get Filename override interpreted as a URL-encoded string.
AppElementsUploadBlobSubelementRequest.Builder	encodedFilename(String value)	Set Filename override interpreted as a URL-encoded string.
Blob	file()	Get File data to upload.
AppElementsUploadBlobSubelementRequest.Builder	file(Blob value)	Set File data to upload.
Number	fileContentLength()	Get The length of the file being uploaded, in bytes.
AppElementsUploadBlobSubelementRequest.Builder	fileContentLength(Number value)	Set The length of the file being uploaded, in bytes.
String	parentChangeId()	Get Id of the last change made by this application to this element
AppElementsUploadBlobSubelementRequest.Builder	parentChangeId(String value)	Set Id of the last change made by this application to this element
String	transactionId()	Get Id of transaction in which the update should be performed
AppElementsUploadBlobSubelementRequest.Builder	transactionId(String value)	Set Id of transaction in which the update should be performed

Methods inherited from class java.lang.Object

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

Method Detail

transactionId

public final String transactionId()

Get Id of transaction in which the update should be performed

Returns:

Id of transaction in which the update should be performed

transactionId

public final AppElementsUploadBlobSubelementRequest.Builder transactionId(String value)

Set Id of transaction in which the update should be performed

Parameters:

value - Id of transaction in which the update should be performed

Returns:

the Builder object.

parentChangeId

public final String parentChangeId()

Get Id of the last change made by this application to this element

Returns:

Id of the last change made by this application to this element

parentChangeId

public final AppElementsUploadBlobSubelementRequest.Builder parentChangeId(String value)

Set Id of the last change made by this application to this element

Parameters:

value - Id of the last change made by this application to this element

Returns:

the Builder object.

description

public final String description()

Get Description of the change being made, for history tracking

Returns:

Description of the change being made, for history tracking

description

public final AppElementsUploadBlobSubelementRequest.Builder description(String value)

Set Description of the change being made, for history tracking

Parameters:

value - Description of the change being made, for history tracking

Returns:

the Builder object.

file

public final Blob file()

Get File data to upload. This field should normally have a Content-Disposition header field with a "filename" attribute, naming the uploaded file.

Returns:

File data to upload. This field should normally have a Content-Disposition header field with a "filename" attribute, naming the uploaded file.

file

public final AppElementsUploadBlobSubelementRequest.Builder file(Blob value)

Set File data to upload. This field should normally have a Content-Disposition header field with a "filename" attribute, naming the uploaded file.

Parameters:

value - File data to upload. This field should normally have a Content-Disposition header field with a "filename" attribute, naming the uploaded file.

Returns:

the Builder object.

encodedFilename

public final String encodedFilename()

Get Filename override interpreted as a URL-encoded string. If specified, this overrides the filename from a Content-Disposition in the file field.

Returns:

Filename override interpreted as a URL-encoded string. If specified, this overrides the filename from a Content-Disposition in the file field.

encodedFilename

public final AppElementsUploadBlobSubelementRequest.Builder encodedFilename(String value)

Set Filename override interpreted as a URL-encoded string. If specified, this overrides the filename from a Content-Disposition in the file field.

Parameters:

value - Filename override interpreted as a URL-encoded string. If specified, this overrides the filename from a Content-Disposition in the file field.

Returns:

the Builder object.

fileContentLength

public final Number fileContentLength()

Get The length of the file being uploaded, in bytes. If not present, Onshape may restrict the upload size under some operating conditions, as the file contents may need to be buffered in memory. If specified, it should be the actual length of the data being uploaded.

Returns:

The length of the file being uploaded, in bytes. If not present, Onshape may restrict the upload size under some operating conditions, as the file contents may need to be buffered in memory. If specified, it should be the actual length of the data being uploaded.

fileContentLength

public final AppElementsUploadBlobSubelementRequest.Builder fileContentLength(Number value)

Set The length of the file being uploaded, in bytes. If not present, Onshape may restrict the upload size under some operating conditions, as the file contents may need to be buffered in memory. If specified, it should be the actual length of the data being uploaded.

Parameters:

value - The length of the file being uploaded, in bytes. If not present, Onshape may restrict the upload size under some operating conditions, as the file contents may need to be buffered in memory. If specified, it should be the actual length of the data being uploaded.

Returns:

the Builder object.

call

public final AppElementsUploadBlobSubelementResponse call(String bid,
                                                          String did,
                                                          String wid,
                                                          String eid)
                                                   throws OnshapeException

Calls uploadBlobSubelement method, Create a blob subelement in an app element from an uploaded file. The request body must have a Content-Type of multipart/form-data. Request Body parameters are multipart fields.

Parameters:

bid - Blob subelement ID

did - Document ID

wid - Workspace ID

eid - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final AppElementsUploadBlobSubelementResponse call(OnshapeDocument document,
                                                          String bid)
                                                   throws OnshapeException

Calls uploadBlobSubelement method, Create a blob subelement in an app element from an uploaded file. The request body must have a Content-Type of multipart/form-data. Request Body parameters are multipart fields.

Parameters:

document - Document object from Onshape URL.

bid - Blob subelement ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error