Package com.onshape.api.requests

Class BlobElementsUploadFileUpdateElementRequest

java.lang.Object

com.onshape.api.requests.BlobElementsUploadFileUpdateElementRequest

public final class BlobElementsUploadFileUpdateElementRequest
extends Object

Request object for uploadFileUpdateElement API endpoint. © 2018-Present Onshape Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BlobElementsUploadFileUpdateElementRequest.Builder

Method Summary

Modifier and Type	Method	Description
static BlobElementsUploadFileUpdateElementRequest.Builder	builder(Onshape onshape)
Boolean	getAllowFaultyParts()	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.
Boolean	getCreateComposite()	Get If the value is specified as true, each part studio contains a single composite part made up of all its topologies.
String	getEncodedFilename()	Get Filename override interpreted as a URL-encoded string.
Blob	getFile()	Get File data to upload.
Number	getFileContentLength()	Get The length of the file being uploaded, in bytes.
Boolean	getFlattenAssemblies()	Get If true, remove assembly structure and create only a Part Studio
Boolean	getImportInBackground()	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).
Boolean	getTranslate()	Get Whether the uploaded file should be translated to Onshape format, if possible
Boolean	getYAxisIsUp()	Get If true, treat the model's Y axis as the vertical axis.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getFile

public final Blob getFile()

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.

getEncodedFilename

public final String getEncodedFilename()

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.

getFileContentLength

public final Number getFileContentLength()

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.

getTranslate

public final Boolean getTranslate()

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

getFlattenAssemblies

public final Boolean getFlattenAssemblies()

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

Returns:

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

getYAxisIsUp

public final Boolean getYAxisIsUp()

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.

getImportInBackground

public final Boolean getImportInBackground()

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.

getAllowFaultyParts

public final Boolean getAllowFaultyParts()

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.

getCreateComposite

public final Boolean getCreateComposite()

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.

toString

public String toString()

Overrides:

toString in class Object

builder

public static final BlobElementsUploadFileUpdateElementRequest.Builder builder(Onshape onshape)