Package com.onshape.api.requests

Class ThumbnailsSetApplicationElementThumbnailRequestThumbnails

java.lang.Object

com.onshape.api.requests.ThumbnailsSetApplicationElementThumbnailRequestThumbnails

public final class ThumbnailsSetApplicationElementThumbnailRequestThumbnails
extends Object

Object used in calls to setApplicationElementThumbnail API endpoint. © 2018-Present Onshape Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ThumbnailsSetApplicationElementThumbnailRequestThumbnails.Builder

Field Summary

Fields

Modifier and Type	Field	Description
String	base64EncodedImage	Base-64 encoded image string.
String	description	An optional description of the image.
Number	imageHeight	The height of the image being supplied.
Number	imageWidth	The width of the image being supplied.
Boolean	isPrimary	If true, this image is used as the element image.
String	uniqueId	A per element unique identifier, which is consistent across document versions and microversions.

Method Summary

Modifier and Type	Method	Description
static ThumbnailsSetApplicationElementThumbnailRequestThumbnails.Builder	builder()
String	getBase64EncodedImage()	Get Base-64 encoded image string.
String	getDescription()	Get An optional description of the image.
Number	getImageHeight()	Get The height of the image being supplied.
Number	getImageWidth()	Get The width of the image being supplied.
Boolean	getIsPrimary()	Get If true, this image is used as the element image.
String	getUniqueId()	Get A per element unique identifier, which is consistent across document versions and microversions.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

uniqueId

public String uniqueId

A per element unique identifier, which is consistent across document versions and microversions.

imageWidth

public Number imageWidth

The width of the image being supplied. Suggested minimum is 600 pixels.

imageHeight

public Number imageHeight

The height of the image being supplied. Suggested minimum is 600 pixels.

isPrimary

public Boolean isPrimary

If true, this image is used as the element image. Only one thumbnail can be designated as the primary thumbnail.

base64EncodedImage

public String base64EncodedImage

Base-64 encoded image string.

description

public String description

An optional description of the image.

Method Detail

getUniqueId

public final String getUniqueId()

Get A per element unique identifier, which is consistent across document versions and microversions.

Returns:

A per element unique identifier, which is consistent across document versions and microversions.

getImageWidth

public final Number getImageWidth()

Get The width of the image being supplied. Suggested minimum is 600 pixels.

Returns:

The width of the image being supplied. Suggested minimum is 600 pixels.

getImageHeight

public final Number getImageHeight()

Get The height of the image being supplied. Suggested minimum is 600 pixels.

Returns:

The height of the image being supplied. Suggested minimum is 600 pixels.

getIsPrimary

public final Boolean getIsPrimary()

Get If true, this image is used as the element image. Only one thumbnail can be designated as the primary thumbnail.

Returns:

If true, this image is used as the element image. Only one thumbnail can be designated as the primary thumbnail.

getBase64EncodedImage

public final String getBase64EncodedImage()

Get Base-64 encoded image string.

Returns:

Base-64 encoded image string.

getDescription

public final String getDescription()

Get An optional description of the image.

Returns:

An optional description of the image.

builder

public static final ThumbnailsSetApplicationElementThumbnailRequestThumbnails.Builder builder()

toString

public String toString()

Overrides:

toString in class Object