Package com.stackone.stackone_client_java.models.operations

Class DocumentsListFilesRequest

  • public class DocumentsListFilesRequest
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      DocumentsListFilesRequest​(java.lang.String xAccountId)  
      DocumentsListFilesRequest​(java.lang.String xAccountId, java.util.Optional<java.lang.String> xStackoneApiSessionToken, org.openapitools.jackson.nullable.JsonNullable<java.lang.Boolean> raw, org.openapitools.jackson.nullable.JsonNullable<? extends java.util.Map<java.lang.String,​java.lang.Object>> proxy, org.openapitools.jackson.nullable.JsonNullable<java.lang.String> fields, org.openapitools.jackson.nullable.JsonNullable<? extends DocumentsListFilesQueryParamFilter> filter, org.openapitools.jackson.nullable.JsonNullable<java.lang.String> page, org.openapitools.jackson.nullable.JsonNullable<java.lang.String> pageSize, org.openapitools.jackson.nullable.JsonNullable<java.lang.String> next, org.openapitools.jackson.nullable.JsonNullable<java.time.OffsetDateTime> updatedAfter, org.openapitools.jackson.nullable.JsonNullable<java.lang.String> folderId, org.openapitools.jackson.nullable.JsonNullable<java.lang.String> nestedItems, org.openapitools.jackson.nullable.JsonNullable<java.lang.String> include)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static DocumentsListFilesRequest.Builder builder()  
      boolean equals​(java.lang.Object o)  
      org.openapitools.jackson.nullable.JsonNullable<java.lang.String> fields()
      The comma separated list of fields that will be returned in the response (if empty, all fields are returned)
      org.openapitools.jackson.nullable.JsonNullable<DocumentsListFilesQueryParamFilter> filter()
      Documents Files Filter
      org.openapitools.jackson.nullable.JsonNullable<java.lang.String> folderId()
      Use to only include Files within the specified Folder.
      int hashCode()  
      org.openapitools.jackson.nullable.JsonNullable<java.lang.String> include()
      The comma separated list of fields that will be included in the response
      org.openapitools.jackson.nullable.JsonNullable<java.lang.String> nestedItems()
      When "true" and used with filter[folder_id], the response includes Files and Files within descendant Folders
      org.openapitools.jackson.nullable.JsonNullable<java.lang.String> next()
      The unified cursor
      org.openapitools.jackson.nullable.JsonNullable<java.lang.String> page()
      Deprecated.
      field: This will be removed in a future release, please migrate away from it as soon as possible.
      org.openapitools.jackson.nullable.JsonNullable<java.lang.String> pageSize()
      The number of results per page (default value is 25)
      org.openapitools.jackson.nullable.JsonNullable<java.util.Map<java.lang.String,​java.lang.Object>> proxy()
      Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key
      org.openapitools.jackson.nullable.JsonNullable<java.lang.Boolean> raw()
      Indicates that the raw request result should be returned in addition to the mapped result (default value is false)
      java.lang.String toString()  
      org.openapitools.jackson.nullable.JsonNullable<java.time.OffsetDateTime> updatedAfter()
      Deprecated.
      field: This will be removed in a future release, please migrate away from it as soon as possible.
      DocumentsListFilesRequest withFields​(java.lang.String fields)
      The comma separated list of fields that will be returned in the response (if empty, all fields are returned)
      DocumentsListFilesRequest withFields​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> fields)
      The comma separated list of fields that will be returned in the response (if empty, all fields are returned)
      DocumentsListFilesRequest withFilter​(DocumentsListFilesQueryParamFilter filter)
      Documents Files Filter
      DocumentsListFilesRequest withFilter​(org.openapitools.jackson.nullable.JsonNullable<? extends DocumentsListFilesQueryParamFilter> filter)
      Documents Files Filter
      DocumentsListFilesRequest withFolderId​(java.lang.String folderId)
      Use to only include Files within the specified Folder.
      DocumentsListFilesRequest withFolderId​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> folderId)
      Use to only include Files within the specified Folder.
      DocumentsListFilesRequest withInclude​(java.lang.String include)
      The comma separated list of fields that will be included in the response
      DocumentsListFilesRequest withInclude​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> include)
      The comma separated list of fields that will be included in the response
      DocumentsListFilesRequest withNestedItems​(java.lang.String nestedItems)
      When "true" and used with filter[folder_id], the response includes Files and Files within descendant Folders
      DocumentsListFilesRequest withNestedItems​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> nestedItems)
      When "true" and used with filter[folder_id], the response includes Files and Files within descendant Folders
      DocumentsListFilesRequest withNext​(java.lang.String next)
      The unified cursor
      DocumentsListFilesRequest withNext​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> next)
      The unified cursor
      DocumentsListFilesRequest withPage​(java.lang.String page)
      Deprecated.
      field: This will be removed in a future release, please migrate away from it as soon as possible.
      DocumentsListFilesRequest withPage​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> page)
      Deprecated.
      field: This will be removed in a future release, please migrate away from it as soon as possible.
      DocumentsListFilesRequest withPageSize​(java.lang.String pageSize)
      The number of results per page (default value is 25)
      DocumentsListFilesRequest withPageSize​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> pageSize)
      The number of results per page (default value is 25)
      DocumentsListFilesRequest withProxy​(java.util.Map<java.lang.String,​java.lang.Object> proxy)
      Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key
      DocumentsListFilesRequest withProxy​(org.openapitools.jackson.nullable.JsonNullable<? extends java.util.Map<java.lang.String,​java.lang.Object>> proxy)
      Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key
      DocumentsListFilesRequest withRaw​(boolean raw)
      Indicates that the raw request result should be returned in addition to the mapped result (default value is false)
      DocumentsListFilesRequest withRaw​(org.openapitools.jackson.nullable.JsonNullable<java.lang.Boolean> raw)
      Indicates that the raw request result should be returned in addition to the mapped result (default value is false)
      DocumentsListFilesRequest withUpdatedAfter​(java.time.OffsetDateTime updatedAfter)
      Deprecated.
      field: This will be removed in a future release, please migrate away from it as soon as possible.
      DocumentsListFilesRequest withUpdatedAfter​(org.openapitools.jackson.nullable.JsonNullable<java.time.OffsetDateTime> updatedAfter)
      Deprecated.
      field: This will be removed in a future release, please migrate away from it as soon as possible.
      DocumentsListFilesRequest withXAccountId​(java.lang.String xAccountId)
      The account identifier
      DocumentsListFilesRequest withXStackoneApiSessionToken​(java.lang.String xStackoneApiSessionToken)
      The session token
      DocumentsListFilesRequest withXStackoneApiSessionToken​(java.util.Optional<java.lang.String> xStackoneApiSessionToken)
      The session token
      java.lang.String xAccountId()
      The account identifier
      java.util.Optional<java.lang.String> xStackoneApiSessionToken()
      The session token

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • DocumentsListFilesRequest

        public DocumentsListFilesRequest​(java.lang.String xAccountId,
                                 java.util.Optional<java.lang.String> xStackoneApiSessionToken,
                                 org.openapitools.jackson.nullable.JsonNullable<java.lang.Boolean> raw,
                                 org.openapitools.jackson.nullable.JsonNullable<? extends java.util.Map<java.lang.String,​java.lang.Object>> proxy,
                                 org.openapitools.jackson.nullable.JsonNullable<java.lang.String> fields,
                                 org.openapitools.jackson.nullable.JsonNullable<? extends DocumentsListFilesQueryParamFilter> filter,
                                 org.openapitools.jackson.nullable.JsonNullable<java.lang.String> page,
                                 org.openapitools.jackson.nullable.JsonNullable<java.lang.String> pageSize,
                                 org.openapitools.jackson.nullable.JsonNullable<java.lang.String> next,
                                 org.openapitools.jackson.nullable.JsonNullable<java.time.OffsetDateTime> updatedAfter,
                                 org.openapitools.jackson.nullable.JsonNullable<java.lang.String> folderId,
                                 org.openapitools.jackson.nullable.JsonNullable<java.lang.String> nestedItems,
                                 org.openapitools.jackson.nullable.JsonNullable<java.lang.String> include)

      • DocumentsListFilesRequest

        public DocumentsListFilesRequest​(java.lang.String xAccountId)

    • Method Detail

      • xAccountId

        public java.lang.String xAccountId()
        The account identifier

      • xStackoneApiSessionToken

        public java.util.Optional<java.lang.String> xStackoneApiSessionToken()
        The session token

      • raw

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.Boolean> raw()
        Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

      • proxy

        public org.openapitools.jackson.nullable.JsonNullable<java.util.Map<java.lang.String,​java.lang.Object>> proxy()
        Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

      • fields

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.String> fields()
        The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

      • page

        @Deprecated
public org.openapitools.jackson.nullable.JsonNullable<java.lang.String> page()
        Deprecated.
        field: This will be removed in a future release, please migrate away from it as soon as possible.
        The page number of the results to fetch

      • pageSize

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.String> pageSize()
        The number of results per page (default value is 25)

      • next

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.String> next()
        The unified cursor

      • updatedAfter

        @Deprecated
public org.openapitools.jackson.nullable.JsonNullable<java.time.OffsetDateTime> updatedAfter()
        Deprecated.
        field: This will be removed in a future release, please migrate away from it as soon as possible.
        Use a string with a date to only select results updated after that given date

      • folderId

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.String> folderId()
        Use to only include Files within the specified Folder. Required when requesting nested items

      • nestedItems

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.String> nestedItems()
        When "true" and used with filter[folder_id], the response includes Files and Files within descendant Folders

      • include

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.String> include()
        The comma separated list of fields that will be included in the response

      • withXStackoneApiSessionToken

        public DocumentsListFilesRequest withXStackoneApiSessionToken​(java.lang.String xStackoneApiSessionToken)
        The session token

      • withXStackoneApiSessionToken

        public DocumentsListFilesRequest withXStackoneApiSessionToken​(java.util.Optional<java.lang.String> xStackoneApiSessionToken)
        The session token

      • withRaw

        public DocumentsListFilesRequest withRaw​(boolean raw)
        Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

      • withRaw

        public DocumentsListFilesRequest withRaw​(org.openapitools.jackson.nullable.JsonNullable<java.lang.Boolean> raw)
        Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

      • withProxy

        public DocumentsListFilesRequest withProxy​(java.util.Map<java.lang.String,​java.lang.Object> proxy)
        Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

      • withProxy

        public DocumentsListFilesRequest withProxy​(org.openapitools.jackson.nullable.JsonNullable<? extends java.util.Map<java.lang.String,​java.lang.Object>> proxy)
        Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

      • withFields

        public DocumentsListFilesRequest withFields​(java.lang.String fields)
        The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

      • withFields

        public DocumentsListFilesRequest withFields​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> fields)
        The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

      • withPage

        @Deprecated
public DocumentsListFilesRequest withPage​(java.lang.String page)
        Deprecated.
        field: This will be removed in a future release, please migrate away from it as soon as possible.
        The page number of the results to fetch

      • withPage

        @Deprecated
public DocumentsListFilesRequest withPage​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> page)
        Deprecated.
        field: This will be removed in a future release, please migrate away from it as soon as possible.
        The page number of the results to fetch

      • withPageSize

        public DocumentsListFilesRequest withPageSize​(java.lang.String pageSize)
        The number of results per page (default value is 25)

      • withPageSize

        public DocumentsListFilesRequest withPageSize​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> pageSize)
        The number of results per page (default value is 25)

      • withNext

        public DocumentsListFilesRequest withNext​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> next)
        The unified cursor

      • withUpdatedAfter

        @Deprecated
public DocumentsListFilesRequest withUpdatedAfter​(java.time.OffsetDateTime updatedAfter)
        Deprecated.
        field: This will be removed in a future release, please migrate away from it as soon as possible.
        Use a string with a date to only select results updated after that given date

      • withUpdatedAfter

        @Deprecated
public DocumentsListFilesRequest withUpdatedAfter​(org.openapitools.jackson.nullable.JsonNullable<java.time.OffsetDateTime> updatedAfter)
        Deprecated.
        field: This will be removed in a future release, please migrate away from it as soon as possible.
        Use a string with a date to only select results updated after that given date

      • withFolderId

        public DocumentsListFilesRequest withFolderId​(java.lang.String folderId)
        Use to only include Files within the specified Folder. Required when requesting nested items

      • withFolderId

        public DocumentsListFilesRequest withFolderId​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> folderId)
        Use to only include Files within the specified Folder. Required when requesting nested items

      • withNestedItems

        public DocumentsListFilesRequest withNestedItems​(java.lang.String nestedItems)
        When "true" and used with filter[folder_id], the response includes Files and Files within descendant Folders

      • withNestedItems

        public DocumentsListFilesRequest withNestedItems​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> nestedItems)
        When "true" and used with filter[folder_id], the response includes Files and Files within descendant Folders

      • withInclude

        public DocumentsListFilesRequest withInclude​(java.lang.String include)
        The comma separated list of fields that will be included in the response

      • withInclude

        public DocumentsListFilesRequest withInclude​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> include)
        The comma separated list of fields that will be included in the response

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object