Package com.onshape.api.requests

Class BlobElementsUploadFileUpdateElementRequest.Builder

java.lang.Object

com.onshape.api.requests.BlobElementsUploadFileUpdateElementRequest.Builder

Enclosing class:

BlobElementsUploadFileUpdateElementRequest

public static final class BlobElementsUploadFileUpdateElementRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
Boolean	allowFaultyParts()	Get If not specified or if specified as false, bodies to be imported are examined for validity and any found to be faulty are removed from the import.
BlobElementsUploadFileUpdateElementRequest.Builder	allowFaultyParts(Boolean value)	Set If not specified or if specified as false, bodies to be imported are examined for validity and any found to be faulty are removed from the import.
BlobElementsUploadFileUpdateElementResponse	call(OnshapeDocument document)	Calls uploadFileUpdateElement method, Update a blob element by uploading a file.
BlobElementsUploadFileUpdateElementResponse	call(String did, String wid, String eid)	Calls uploadFileUpdateElement method, Update a blob element by uploading a file.
Boolean	createComposite()	Get If the value is specified as true, each part studio contains a single composite part made up of all its topologies.
BlobElementsUploadFileUpdateElementRequest.Builder	createComposite(Boolean value)	Set If the value is specified as true, each part studio contains a single composite part made up of all its topologies.
String	encodedFilename()	Get Filename override interpreted as a URL-encoded string.
BlobElementsUploadFileUpdateElementRequest.Builder	encodedFilename(String value)	Set Filename override interpreted as a URL-encoded string.
Blob	file()	Get File data to upload.
BlobElementsUploadFileUpdateElementRequest.Builder	file(Blob value)	Set File data to upload.
Number	fileContentLength()	Get The length of the file being uploaded, in bytes.
BlobElementsUploadFileUpdateElementRequest.Builder	fileContentLength(Number value)	Set The length of the file being uploaded, in bytes.
Boolean	flattenAssemblies()	Get If true, remove assembly structure and create only a Part Studio
BlobElementsUploadFileUpdateElementRequest.Builder	flattenAssemblies(Boolean value)	Set If true, remove assembly structure and create only a Part Studio
Boolean	importInBackground()	Get If storeInDocument is true and formatName is ONSHAPE and the source is a Parasolid file, this specifies the preference as to whether the import should be completed prior to the completion of the request (importInBackground=false) or whether it should be performed asynchronously (importInBackground=true).
BlobElementsUploadFileUpdateElementRequest.Builder	importInBackground(Boolean value)	Set If storeInDocument is true and formatName is ONSHAPE and the source is a Parasolid file, this specifies the preference as to whether the import should be completed prior to the completion of the request (importInBackground=false) or whether it should be performed asynchronously (importInBackground=true).
String	parentChangeId()	Get The element microversion of the blob element that will be updated.
BlobElementsUploadFileUpdateElementRequest.Builder	parentChangeId(String value)	Set The element microversion of the blob element that will be updated.
Boolean	translate()	Get Whether the uploaded file should be translated to Onshape format, if possible
BlobElementsUploadFileUpdateElementRequest.Builder	translate(Boolean value)	Set Whether the uploaded file should be translated to Onshape format, if possible
Boolean	yAxisIsUp()	Get If true, treat the model's Y axis as the vertical axis.
BlobElementsUploadFileUpdateElementRequest.Builder	yAxisIsUp(Boolean value)	Set If true, treat the model's Y axis as the vertical axis.

Methods inherited from class java.lang.Object

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

Method Detail

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 BlobElementsUploadFileUpdateElementRequest.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 BlobElementsUploadFileUpdateElementRequest.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 BlobElementsUploadFileUpdateElementRequest.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.

translate

public final Boolean translate()

Get Whether the uploaded file should be translated to Onshape format, if possible

Returns:

Whether the uploaded file should be translated to Onshape format, if possible

translate

public final BlobElementsUploadFileUpdateElementRequest.Builder translate(Boolean value)

Set Whether the uploaded file should be translated to Onshape format, if possible

Parameters:

value - Whether the uploaded file should be translated to Onshape format, if possible

Returns:

the Builder object.

flattenAssemblies

public final Boolean flattenAssemblies()

Get If true, remove assembly structure and create only a Part Studio

Returns:

If true, remove assembly structure and create only a Part Studio

flattenAssemblies

public final BlobElementsUploadFileUpdateElementRequest.Builder flattenAssemblies(Boolean value)

Set If true, remove assembly structure and create only a Part Studio

Parameters:

value - If true, remove assembly structure and create only a Part Studio

Returns:

the Builder object.

yAxisIsUp

public final Boolean yAxisIsUp()

Get If true, treat the model's Y axis as the vertical axis. Otherwise, Z is treated as the vertical axis.

Returns:

If true, treat the model's Y axis as the vertical axis. Otherwise, Z is treated as the vertical axis.

yAxisIsUp

public final BlobElementsUploadFileUpdateElementRequest.Builder yAxisIsUp(Boolean value)

Set If true, treat the model's Y axis as the vertical axis. Otherwise, Z is treated as the vertical axis.

Parameters:

value - If true, treat the model's Y axis as the vertical axis. Otherwise, Z is treated as the vertical axis.

Returns:

the Builder object.

importInBackground

public final Boolean importInBackground()

Get If storeInDocument is true and formatName is ONSHAPE and the source is a Parasolid file, this specifies the preference as to whether the import should be completed prior to the completion of the request (importInBackground=false) or whether it should be performed asynchronously (importInBackground=true). Historically, this parameter was implicitly set to false, but large imports can take long enough that the request could result in a timeout. Applications are encouraged to set this parameter to true for reliable operation.

Returns:

If storeInDocument is true and formatName is ONSHAPE and the source is a Parasolid file, this specifies the preference as to whether the import should be completed prior to the completion of the request (importInBackground=false) or whether it should be performed asynchronously (importInBackground=true). Historically, this parameter was implicitly set to false, but large imports can take long enough that the request could result in a timeout. Applications are encouraged to set this parameter to true for reliable operation.

importInBackground

public final BlobElementsUploadFileUpdateElementRequest.Builder importInBackground(Boolean value)

Set If storeInDocument is true and formatName is ONSHAPE and the source is a Parasolid file, this specifies the preference as to whether the import should be completed prior to the completion of the request (importInBackground=false) or whether it should be performed asynchronously (importInBackground=true). Historically, this parameter was implicitly set to false, but large imports can take long enough that the request could result in a timeout. Applications are encouraged to set this parameter to true for reliable operation.

Parameters:

value - If storeInDocument is true and formatName is ONSHAPE and the source is a Parasolid file, this specifies the preference as to whether the import should be completed prior to the completion of the request (importInBackground=false) or whether it should be performed asynchronously (importInBackground=true). Historically, this parameter was implicitly set to false, but large imports can take long enough that the request could result in a timeout. Applications are encouraged to set this parameter to true for reliable operation.

Returns:

the Builder object.

allowFaultyParts

public final Boolean allowFaultyParts()

Get If not specified or if specified as false, bodies to be imported are examined for validity and any found to be faulty are removed from the import. If all bodies are found to be faulty, the import fails. If the value is specified as true, we attempt to import the bodies that appear to have faults.

Returns:

If not specified or if specified as false, bodies to be imported are examined for validity and any found to be faulty are removed from the import. If all bodies are found to be faulty, the import fails. If the value is specified as true, we attempt to import the bodies that appear to have faults.

allowFaultyParts

public final BlobElementsUploadFileUpdateElementRequest.Builder allowFaultyParts(Boolean value)

Set If not specified or if specified as false, bodies to be imported are examined for validity and any found to be faulty are removed from the import. If all bodies are found to be faulty, the import fails. If the value is specified as true, we attempt to import the bodies that appear to have faults.

Parameters:

value - If not specified or if specified as false, bodies to be imported are examined for validity and any found to be faulty are removed from the import. If all bodies are found to be faulty, the import fails. If the value is specified as true, we attempt to import the bodies that appear to have faults.

Returns:

the Builder object.

createComposite

public final Boolean createComposite()

Get If the value is specified as true, each part studio contains a single composite part made up of all its topologies.

Returns:

If the value is specified as true, each part studio contains a single composite part made up of all its topologies.

createComposite

public final BlobElementsUploadFileUpdateElementRequest.Builder createComposite(Boolean value)

Set If the value is specified as true, each part studio contains a single composite part made up of all its topologies.

Parameters:

value - If the value is specified as true, each part studio contains a single composite part made up of all its topologies.

Returns:

the Builder object.

parentChangeId

public final String parentChangeId()

Get The element microversion of the blob element that will be updated. If the requested mv doesn't match the workspace mv, this call will result in a 400. The element microversionId can be retrieved from documents:getElementList.

Returns:

The element microversion of the blob element that will be updated. If the requested mv doesn't match the workspace mv, this call will result in a 400. The element microversionId can be retrieved from documents:getElementList.

parentChangeId

public final BlobElementsUploadFileUpdateElementRequest.Builder parentChangeId(String value)

Set The element microversion of the blob element that will be updated. If the requested mv doesn't match the workspace mv, this call will result in a 400. The element microversionId can be retrieved from documents:getElementList.

Parameters:

value - The element microversion of the blob element that will be updated. If the requested mv doesn't match the workspace mv, this call will result in a 400. The element microversionId can be retrieved from documents:getElementList.

Returns:

the Builder object.

call

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

Calls uploadFileUpdateElement method, Update a blob element by uploading a file. The request body must have a Content-Type of multipart/form-data. Request Body parameters are multipart fields.

Parameters:

did - Document ID

wid - Workspace ID

eid - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final BlobElementsUploadFileUpdateElementResponse call(OnshapeDocument document)
                                                       throws OnshapeException

Calls uploadFileUpdateElement method, Update a blob element by uploading a 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.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error