Vault.Matters.Holds.List (Google Vault API v1-rev20251015-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.vault.v1.VaultRequest<ListHoldsResponse>
        
        com.google.api.services.vault.v1.Vault.Matters.Holds.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Vault.Matters.Holds
```
public class Vault.Matters.Holds.List
extends VaultRequest<ListHoldsResponse>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected List(String matterId)
Lists the holds in a matter.

Constructors
Modifier	Constructor and Description
`protected`	`List(String matterId)` Lists the holds in a matter.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`String`	`getMatterId()` The matter ID.
`Integer`	`getPageSize()` The number of holds to return in the response, between 0 and 100 inclusive.
`String`	`getPageToken()` The pagination token as returned in the response.
`String`	`getView()` The amount of detail to return for a hold.
`Vault.Matters.Holds.List`	`set(String parameterName, Object value)`
`Vault.Matters.Holds.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Vault.Matters.Holds.List`	`setAccessToken(String accessToken)` OAuth access token.
`Vault.Matters.Holds.List`	`setAlt(String alt)` Data format for response.
`Vault.Matters.Holds.List`	`setCallback(String callback)` JSONP
`Vault.Matters.Holds.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Vault.Matters.Holds.List`	`setKey(String key)` API key.
`Vault.Matters.Holds.List`	`setMatterId(String matterId)` The matter ID.
`Vault.Matters.Holds.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Vault.Matters.Holds.List`	`setPageSize(Integer pageSize)` The number of holds to return in the response, between 0 and 100 inclusive.
`Vault.Matters.Holds.List`	`setPageToken(String pageToken)` The pagination token as returned in the response.
`Vault.Matters.Holds.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Vault.Matters.Holds.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Vault.Matters.Holds.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Vault.Matters.Holds.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.
`Vault.Matters.Holds.List`	`setView(String view)` The amount of detail to return for a hold.

Methods inherited from class com.google.api.services.vault.v1.VaultRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - List
```
protected List(String matterId)
```
    Lists the holds in a matter. Create a request for the method "holds.list". This request holds the parameters needed by the the vault server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Vault.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    matterId - The matter ID.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListHoldsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListHoldsResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Vault.Matters.Holds.List set$Xgafv(String $Xgafv)
```
    Description copied from class: VaultRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class VaultRequest<ListHoldsResponse>
  - setAccessToken
```
public Vault.Matters.Holds.List setAccessToken(String accessToken)
```
    Description copied from class: VaultRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class VaultRequest<ListHoldsResponse>
  - setAlt
```
public Vault.Matters.Holds.List setAlt(String alt)
```
    Description copied from class: VaultRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class VaultRequest<ListHoldsResponse>
  - setCallback
```
public Vault.Matters.Holds.List setCallback(String callback)
```
    Description copied from class: VaultRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class VaultRequest<ListHoldsResponse>
  - setFields
```
public Vault.Matters.Holds.List setFields(String fields)
```
    Description copied from class: VaultRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class VaultRequest<ListHoldsResponse>
  - setKey
```
public Vault.Matters.Holds.List setKey(String key)
```
    Description copied from class: VaultRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class VaultRequest<ListHoldsResponse>
  - setOauthToken
```
public Vault.Matters.Holds.List setOauthToken(String oauthToken)
```
    Description copied from class: VaultRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class VaultRequest<ListHoldsResponse>
  - setPrettyPrint
```
public Vault.Matters.Holds.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: VaultRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class VaultRequest<ListHoldsResponse>
  - setQuotaUser
```
public Vault.Matters.Holds.List setQuotaUser(String quotaUser)
```
    Description copied from class: VaultRequest
    
    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class VaultRequest<ListHoldsResponse>
  - setUploadType
```
public Vault.Matters.Holds.List setUploadType(String uploadType)
```
    Description copied from class: VaultRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class VaultRequest<ListHoldsResponse>
  - setUploadProtocol
```
public Vault.Matters.Holds.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: VaultRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class VaultRequest<ListHoldsResponse>
  - getMatterId
```
public String getMatterId()
```
    The matter ID.
  - setMatterId
```
public Vault.Matters.Holds.List setMatterId(String matterId)
```
    The matter ID.
  - getPageSize
```
public Integer getPageSize()
```
    The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as **page_size** = 100.
  - setPageSize
```
public Vault.Matters.Holds.List setPageSize(Integer pageSize)
```
    The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as **page_size** = 100.
  - getPageToken
```
public String getPageToken()
```
    The pagination token as returned in the response. An empty token means start from the beginning.
  - setPageToken
```
public Vault.Matters.Holds.List setPageToken(String pageToken)
```
    The pagination token as returned in the response. An empty token means start from the beginning.
  - getView
```
public String getView()
```
    The amount of detail to return for a hold.
  - setView
```
public Vault.Matters.Holds.List setView(String view)
```
    The amount of detail to return for a hold.
  - set
```
public Vault.Matters.Holds.List set(String parameterName,
                                    Object value)
```
    Overrides:
    
    set in class VaultRequest<ListHoldsResponse>

Class Vault.Matters.Holds.List

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.vault.v1.VaultRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getMatterId

setMatterId

getPageSize

setPageSize

getPageToken

setPageToken

getView

setView

set