DocumentsGetDocumentsResponseItems (api-client 1.137.27923.860f36b32a5a API)

java.lang.Object
- com.onshape.api.types.AbstractResponseObject
- - com.onshape.api.responses.DocumentsGetDocumentsResponseItems

public final class DocumentsGetDocumentsResponseItems
extends AbstractResponseObject

Field Summary

Fields
Modifier and Type	Field	Description
`Boolean`	`active`	Whether a shared document is active
`Boolean`	`canUnshare`	Whether document can be unshared
`Date`	`createdAt`	Creation date
`DocumentsGetDocumentsResponseItemsCreatedBy`	`createdBy`	User information for the creator of the document
`DocumentsGetDocumentsResponseItemsDefaultWorkspace`	`defaultWorkspace`	Information about the default workspace
`String`	`href`	Document URL
`String`	`id`	Document ID
`Boolean`	`isPublic`	Whether document is public
`Date`	`modifiedAt`	Date of last modification
`DocumentsGetDocumentsResponseItemsModifiedBy`	`modifiedBy`	User information for the last modifier of the document
`String`	`name`	Name of document
`DocumentsGetDocumentsResponseItemsOwner`	`owner`	Information about document owner
`String`	`permission`	Onshape internal use
`Number`	`sizeBytes`	Size of document in bytes
`String`	`starred`	Whether document has been starred
`String[]`	`tags`	Reserved for future use
`DocumentsGetDocumentsResponseItemsThumbnail`	`thumbnail`	Thumbnail information
`Number`	`totalWorkspacesScheduledForUpdate`	Number of workspaces that are scheduled for updating
`Number`	`totalWorkspacesUpdating`	Number of workspaces that are updating
`Boolean`	`trash`	Whether document has been trashed
`Date`	`trashedAt`	When document has been trashed

Constructor Summary

Constructors
Constructor Description

DocumentsGetDocumentsResponseItems()

Constructors
Constructor	Description
`DocumentsGetDocumentsResponseItems()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Boolean`	`getActive()`	Get Whether a shared document is active
`Boolean`	`getCanUnshare()`	Get Whether document can be unshared
`Date`	`getCreatedAt()`	Get Creation date
`DocumentsGetDocumentsResponseItemsCreatedBy`	`getCreatedBy()`	Get User information for the creator of the document
`DocumentsGetDocumentsResponseItemsDefaultWorkspace`	`getDefaultWorkspace()`	Get Information about the default workspace
`String`	`getHref()`	Get Document URL
`String`	`getId()`	Get Document ID
`Boolean`	`getIsPublic()`	Get Whether document is public
`Date`	`getModifiedAt()`	Get Date of last modification
`DocumentsGetDocumentsResponseItemsModifiedBy`	`getModifiedBy()`	Get User information for the last modifier of the document
`String`	`getName()`	Get Name of document
`DocumentsGetDocumentsResponseItemsOwner`	`getOwner()`	Get Information about document owner
`String`	`getPermission()`	Get Onshape internal use
`Number`	`getSizeBytes()`	Get Size of document in bytes
`String`	`getStarred()`	Get Whether document has been starred
`String[]`	`getTags()`	Get Reserved for future use
`DocumentsGetDocumentsResponseItemsThumbnail`	`getThumbnail()`	Get Thumbnail information
`Number`	`getTotalWorkspacesScheduledForUpdate()`	Get Number of workspaces that are scheduled for updating
`Number`	`getTotalWorkspacesUpdating()`	Get Number of workspaces that are updating
`Boolean`	`getTrash()`	Get Whether document has been trashed
`Date`	`getTrashedAt()`	Get When document has been trashed
`String`	`toString()`

Methods inherited from class com.onshape.api.types.AbstractResponseObject
getOtherProperties

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - isPublic
```
public Boolean isPublic
```
    Whether document is public
  - owner
```
public DocumentsGetDocumentsResponseItemsOwner owner
```
    Information about document owner
  - permission
```
public String permission
```
    Onshape internal use
  - trashedAt
```
public Date trashedAt
```
    When document has been trashed
  - trash
```
public Boolean trash
```
    Whether document has been trashed
  - starred
```
public String starred
```
    Whether document has been starred
  - active
```
public Boolean active
```
    Whether a shared document is active
  - createdAt
```
public Date createdAt
```
    Creation date
  - thumbnail
```
public DocumentsGetDocumentsResponseItemsThumbnail thumbnail
```
    Thumbnail information
  - createdBy
```
public DocumentsGetDocumentsResponseItemsCreatedBy createdBy
```
    User information for the creator of the document
  - modifiedAt
```
public Date modifiedAt
```
    Date of last modification
  - modifiedBy
```
public DocumentsGetDocumentsResponseItemsModifiedBy modifiedBy
```
    User information for the last modifier of the document
  - defaultWorkspace
```
public DocumentsGetDocumentsResponseItemsDefaultWorkspace defaultWorkspace
```
    Information about the default workspace
  - tags
```
public String[] tags
```
    Reserved for future use
  - sizeBytes
```
public Number sizeBytes
```
    Size of document in bytes
  - canUnshare
```
public Boolean canUnshare
```
    Whether document can be unshared
  - name
```
public String name
```
    Name of document
  - id
```
public String id
```
    Document ID
  - href
```
public String href
```
    Document URL
  - totalWorkspacesUpdating
```
public Number totalWorkspacesUpdating
```
    Number of workspaces that are updating
  - totalWorkspacesScheduledForUpdate
```
public Number totalWorkspacesScheduledForUpdate
```
    Number of workspaces that are scheduled for updating
- Constructor Detail
  - DocumentsGetDocumentsResponseItems
```
public DocumentsGetDocumentsResponseItems()
```
- Method Detail
  - getIsPublic
```
public final Boolean getIsPublic()
```
    Get Whether document is public
    
    Returns:
    
    Whether document is public
  - getOwner
```
public final DocumentsGetDocumentsResponseItemsOwner getOwner()
```
    Get Information about document owner
    
    Returns:
    
    Information about document owner
  - getPermission
```
public final String getPermission()
```
    Get Onshape internal use
    
    Returns:
    
    Onshape internal use
  - getTrashedAt
```
public final Date getTrashedAt()
```
    Get When document has been trashed
    
    Returns:
    
    When document has been trashed
  - getTrash
```
public final Boolean getTrash()
```
    Get Whether document has been trashed
    
    Returns:
    
    Whether document has been trashed
  - getStarred
```
public final String getStarred()
```
    Get Whether document has been starred
    
    Returns:
    
    Whether document has been starred
  - getActive
```
public final Boolean getActive()
```
    Get Whether a shared document is active
    
    Returns:
    
    Whether a shared document is active
  - getCreatedAt
```
public final Date getCreatedAt()
```
    Get Creation date
    
    Returns:
    
    Creation date
  - getThumbnail
```
public final DocumentsGetDocumentsResponseItemsThumbnail getThumbnail()
```
    Get Thumbnail information
    
    Returns:
    
    Thumbnail information
  - getCreatedBy
```
public final DocumentsGetDocumentsResponseItemsCreatedBy getCreatedBy()
```
    Get User information for the creator of the document
    
    Returns:
    
    User information for the creator of the document
  - getModifiedAt
```
public final Date getModifiedAt()
```
    Get Date of last modification
    
    Returns:
    
    Date of last modification
  - getModifiedBy
```
public final DocumentsGetDocumentsResponseItemsModifiedBy getModifiedBy()
```
    Get User information for the last modifier of the document
    
    Returns:
    
    User information for the last modifier of the document
  - getDefaultWorkspace
```
public final DocumentsGetDocumentsResponseItemsDefaultWorkspace getDefaultWorkspace()
```
    Get Information about the default workspace
    
    Returns:
    
    Information about the default workspace
  - getTags
```
public final String[] getTags()
```
    Get Reserved for future use
    
    Returns:
    
    Reserved for future use
  - getSizeBytes
```
public final Number getSizeBytes()
```
    Get Size of document in bytes
    
    Returns:
    
    Size of document in bytes
  - getCanUnshare
```
public final Boolean getCanUnshare()
```
    Get Whether document can be unshared
    
    Returns:
    
    Whether document can be unshared
  - getName
```
public final String getName()
```
    Get Name of document
    
    Returns:
    
    Name of document
  - getId
```
public final String getId()
```
    Get Document ID
    
    Returns:
    
    Document ID
  - getHref
```
public final String getHref()
```
    Get Document URL
    
    Returns:
    
    Document URL
  - getTotalWorkspacesUpdating
```
public final Number getTotalWorkspacesUpdating()
```
    Get Number of workspaces that are updating
    
    Returns:
    
    Number of workspaces that are updating
  - getTotalWorkspacesScheduledForUpdate
```
public final Number getTotalWorkspacesScheduledForUpdate()
```
    Get Number of workspaces that are scheduled for updating
    
    Returns:
    
    Number of workspaces that are scheduled for updating
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DocumentsGetDocumentsResponseItems

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.onshape.api.types.AbstractResponseObject

Methods inherited from class java.lang.Object

Field Detail

isPublic

owner

permission

trashedAt

trash

starred

active

createdAt

thumbnail

createdBy

modifiedAt

modifiedBy

defaultWorkspace

tags

sizeBytes

canUnshare

name

id

href

totalWorkspacesUpdating

totalWorkspacesScheduledForUpdate

Constructor Detail

DocumentsGetDocumentsResponseItems

Method Detail

getIsPublic

getOwner

getPermission

getTrashedAt

getTrash

getStarred

getActive

getCreatedAt

getThumbnail

getCreatedBy

getModifiedAt

getModifiedBy

getDefaultWorkspace

getTags

getSizeBytes

getCanUnshare

getName

getId

getHref

getTotalWorkspacesUpdating

getTotalWorkspacesScheduledForUpdate

toString