Package com.onshape.api.requests

Class BlobElementsUploadFileCreateElementRequest.Builder

java.lang.Object

com.onshape.api.requests.BlobElementsUploadFileCreateElementRequest.Builder

Enclosing class:

BlobElementsUploadFileCreateElementRequest

public static final class BlobElementsUploadFileCreateElementRequest.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.
BlobElementsUploadFileCreateElementRequest.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.
BlobElementsUploadFileCreateElementResponse	call(OnshapeDocument document)	Calls uploadFileCreateElement method, Create a blob element from an uploaded file.
BlobElementsUploadFileCreateElementResponse	call(String did, String wid)	Calls uploadFileCreateElement method, Create a blob element from an uploaded 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.
BlobElementsUploadFileCreateElementRequest.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.
Boolean	createDrawingIfPossible()	Get If true and the uploaded file is a DXF or a DWG, automatically create a Drawing element along with the Blob element.
BlobElementsUploadFileCreateElementRequest.Builder	createDrawingIfPossible(Boolean value)	Set If true and the uploaded file is a DXF or a DWG, automatically create a Drawing element along with the Blob element.
String	encodedFilename()	Get Filename override interpreted as a URL-encoded string.
BlobElementsUploadFileCreateElementRequest.Builder	encodedFilename(String value)	Set Filename override interpreted as a URL-encoded string.
Blob	file()	Get File data to upload.
BlobElementsUploadFileCreateElementRequest.Builder	file(Blob value)	Set File data to upload.
Number	fileContentLength()	Get The length of the file being uploaded, in bytes.
BlobElementsUploadFileCreateElementRequest.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
BlobElementsUploadFileCreateElementRequest.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).
BlobElementsUploadFileCreateElementRequest.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	locationElementId()	Get Id of an element to place the new element near.
BlobElementsUploadFileCreateElementRequest.Builder	locationElementId(String value)	Set Id of an element to place the new element near.
String	locationGroupId()	Get For internal use.
BlobElementsUploadFileCreateElementRequest.Builder	locationGroupId(String value)	Set For internal use.
Number	locationPosition()	Get An indicator for the relative placement of the new element.
BlobElementsUploadFileCreateElementRequest.Builder	locationPosition(Number value)	Set An indicator for the relative placement of the new element.
Boolean	translate()	Get Whether the uploaded file should be translated to Onshape format, if possible
BlobElementsUploadFileCreateElementRequest.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.
BlobElementsUploadFileCreateElementRequest.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

createDrawingIfPossible

public final Boolean createDrawingIfPossible()

Get If true and the uploaded file is a DXF or a DWG, automatically create a Drawing element along with the Blob element. Otherwise, just create the Blob element.

Returns:

If true and the uploaded file is a DXF or a DWG, automatically create a Drawing element along with the Blob element. Otherwise, just create the Blob element.

createDrawingIfPossible

public final BlobElementsUploadFileCreateElementRequest.Builder createDrawingIfPossible(Boolean value)

Set If true and the uploaded file is a DXF or a DWG, automatically create a Drawing element along with the Blob element. Otherwise, just create the Blob element.

Parameters:

value - If true and the uploaded file is a DXF or a DWG, automatically create a Drawing element along with the Blob element. Otherwise, just create the Blob element.

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

locationGroupId

public final String locationGroupId()

Get For internal use.

Returns:

For internal use.

locationGroupId

public final BlobElementsUploadFileCreateElementRequest.Builder locationGroupId(String value)

Set For internal use.

Parameters:

value - For internal use.

Returns:

the Builder object.

locationElementId

public final String locationElementId()

Get Id of an element to place the new element near.

Returns:

Id of an element to place the new element near.

locationElementId

public final BlobElementsUploadFileCreateElementRequest.Builder locationElementId(String value)

Set Id of an element to place the new element near.

Parameters:

value - Id of an element to place the new element near.

Returns:

the Builder object.

locationPosition

public final Number locationPosition()

Get An indicator for the relative placement of the new element. If locationElementId is specified, a negative number indicates insertion prior to the element and a non-negative number indicates insertion following the element. If no elementId is specified, a negative value indicates insertion at the end of the group or element list and a non-negative number indicates insertion at the start of the group or elmenet list.

Returns:

An indicator for the relative placement of the new element. If locationElementId is specified, a negative number indicates insertion prior to the element and a non-negative number indicates insertion following the element. If no elementId is specified, a negative value indicates insertion at the end of the group or element list and a non-negative number indicates insertion at the start of the group or elmenet list.

locationPosition

public final BlobElementsUploadFileCreateElementRequest.Builder locationPosition(Number value)

Set An indicator for the relative placement of the new element. If locationElementId is specified, a negative number indicates insertion prior to the element and a non-negative number indicates insertion following the element. If no elementId is specified, a negative value indicates insertion at the end of the group or element list and a non-negative number indicates insertion at the start of the group or elmenet list.

Parameters:

value - An indicator for the relative placement of the new element. If locationElementId is specified, a negative number indicates insertion prior to the element and a non-negative number indicates insertion following the element. If no elementId is specified, a negative value indicates insertion at the end of the group or element list and a non-negative number indicates insertion at the start of the group or elmenet list.

Returns:

the Builder object.

call

public final BlobElementsUploadFileCreateElementResponse call(String did,
                                                              String wid)
                                                       throws OnshapeException

Calls uploadFileCreateElement method, Create a blob element from an uploaded 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

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final BlobElementsUploadFileCreateElementResponse call(OnshapeDocument document)
                                                       throws OnshapeException

Calls uploadFileCreateElement method, Create a blob 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.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error