Storagetransfer.TransferOperations.List (Storage Transfer API v1-rev20240622-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.storagetransfer.v1.StoragetransferRequest<ListOperationsResponse>
        
        com.google.api.services.storagetransfer.v1.Storagetransfer.TransferOperations.List

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: Storagetransfer.TransferOperations

public class Storagetransfer.TransferOperations.List
extends StoragetransferRequest<ListOperationsResponse>

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 name, String filter)
Lists transfer operations.

Constructors
Modifier	Constructor and Description
`protected`	`List(String name, String filter)` Lists transfer operations.

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`	`getFilter()` Required.
`String`	`getName()` Required.
`Integer`	`getPageSize()` The list page size.
`String`	`getPageToken()` The list page token.
`Storagetransfer.TransferOperations.List`	`set(String parameterName, Object value)`
`Storagetransfer.TransferOperations.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Storagetransfer.TransferOperations.List`	`setAccessToken(String accessToken)` OAuth access token.
`Storagetransfer.TransferOperations.List`	`setAlt(String alt)` Data format for response.
`Storagetransfer.TransferOperations.List`	`setCallback(String callback)` JSONP
`Storagetransfer.TransferOperations.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Storagetransfer.TransferOperations.List`	`setFilter(String filter)` Required.
`Storagetransfer.TransferOperations.List`	`setKey(String key)` API key.
`Storagetransfer.TransferOperations.List`	`setName(String name)` Required.
`Storagetransfer.TransferOperations.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Storagetransfer.TransferOperations.List`	`setPageSize(Integer pageSize)` The list page size.
`Storagetransfer.TransferOperations.List`	`setPageToken(String pageToken)` The list page token.
`Storagetransfer.TransferOperations.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Storagetransfer.TransferOperations.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Storagetransfer.TransferOperations.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Storagetransfer.TransferOperations.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.storagetransfer.v1.StoragetransferRequest
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 name,
               String filter)
```
    Lists transfer operations. Operations are ordered by their creation time in reverse chronological order. Create a request for the method "transferOperations.list". This request holds the parameters needed by the the storagetransfer server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Storagetransfer.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    name - Required. The name of the type being listed; must be `transferOperations`.
    
    filter - Required. A list of query parameters specified as JSON text in the form of: `{"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobNamePattern": "job_name_pattern", "operationNames":["opid1","opid2",...], "operationNamePattern": "operation_name_pattern", "minCreationTime": "min_creation_time", "maxCreationTime": "max_creation_time", "transferStatuses":["status1","status2",...]}` Since `jobNames`, `operationNames`, and `transferStatuses` support multiple values, they must be specified with array notation. `projectId` is the only argument that is required. If specified, `jobNamePattern` and `operationNamePattern` must match the full job or operation name respectively. '*' is a wildcard matching 0 or more characters. `minCreationTime` and `maxCreationTime` should be timestamps encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. The valid values for `transferStatuses` are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED.
    
    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<ListOperationsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListOperationsResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Storagetransfer.TransferOperations.List set$Xgafv(String $Xgafv)
```
    Description copied from class: StoragetransferRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class StoragetransferRequest<ListOperationsResponse>
  - setAccessToken
```
public Storagetransfer.TransferOperations.List setAccessToken(String accessToken)
```
    Description copied from class: StoragetransferRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class StoragetransferRequest<ListOperationsResponse>
  - setAlt
```
public Storagetransfer.TransferOperations.List setAlt(String alt)
```
    Description copied from class: StoragetransferRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class StoragetransferRequest<ListOperationsResponse>
  - setCallback
```
public Storagetransfer.TransferOperations.List setCallback(String callback)
```
    Description copied from class: StoragetransferRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class StoragetransferRequest<ListOperationsResponse>
  - setFields
```
public Storagetransfer.TransferOperations.List setFields(String fields)
```
    Description copied from class: StoragetransferRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class StoragetransferRequest<ListOperationsResponse>
  - setKey
```
public Storagetransfer.TransferOperations.List setKey(String key)
```
    Description copied from class: StoragetransferRequest
    
    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 StoragetransferRequest<ListOperationsResponse>
  - setOauthToken
```
public Storagetransfer.TransferOperations.List setOauthToken(String oauthToken)
```
    Description copied from class: StoragetransferRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class StoragetransferRequest<ListOperationsResponse>
  - setPrettyPrint
```
public Storagetransfer.TransferOperations.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: StoragetransferRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class StoragetransferRequest<ListOperationsResponse>
  - setQuotaUser
```
public Storagetransfer.TransferOperations.List setQuotaUser(String quotaUser)
```
    Description copied from class: StoragetransferRequest
    
    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 StoragetransferRequest<ListOperationsResponse>
  - setUploadType
```
public Storagetransfer.TransferOperations.List setUploadType(String uploadType)
```
    Description copied from class: StoragetransferRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class StoragetransferRequest<ListOperationsResponse>
  - setUploadProtocol
```
public Storagetransfer.TransferOperations.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: StoragetransferRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class StoragetransferRequest<ListOperationsResponse>
  - getName
```
public String getName()
```
    Required. The name of the type being listed; must be `transferOperations`.
  - setName
```
public Storagetransfer.TransferOperations.List setName(String name)
```
    Required. The name of the type being listed; must be `transferOperations`.
  - getFilter
```
public String getFilter()
```
    Required. A list of query parameters specified as JSON text in the form of: `{"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobNamePattern": "job_name_pattern", "operationNames":["opid1","opid2",...], "operationNamePattern": "operation_name_pattern", "minCreationTime": "min_creation_time", "maxCreationTime": "max_creation_time", "transferStatuses":["status1","status2",...]}` Since `jobNames`, `operationNames`, and `transferStatuses` support multiple values, they must be specified with array notation. `projectId` is the only argument that is required. If specified, `jobNamePattern` and `operationNamePattern` must match the full job or operation name respectively. '*' is a wildcard matching 0 or more characters. `minCreationTime` and `maxCreationTime` should be timestamps encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. The valid values for `transferStatuses` are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED.
  - setFilter
```
public Storagetransfer.TransferOperations.List setFilter(String filter)
```
    Required. A list of query parameters specified as JSON text in the form of: `{"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobNamePattern": "job_name_pattern", "operationNames":["opid1","opid2",...], "operationNamePattern": "operation_name_pattern", "minCreationTime": "min_creation_time", "maxCreationTime": "max_creation_time", "transferStatuses":["status1","status2",...]}` Since `jobNames`, `operationNames`, and `transferStatuses` support multiple values, they must be specified with array notation. `projectId` is the only argument that is required. If specified, `jobNamePattern` and `operationNamePattern` must match the full job or operation name respectively. '*' is a wildcard matching 0 or more characters. `minCreationTime` and `maxCreationTime` should be timestamps encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. The valid values for `transferStatuses` are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED.
  - getPageSize
```
public Integer getPageSize()
```
    The list page size. The max allowed value is 256.
  - setPageSize
```
public Storagetransfer.TransferOperations.List setPageSize(Integer pageSize)
```
    The list page size. The max allowed value is 256.
  - getPageToken
```
public String getPageToken()
```
    The list page token.
  - setPageToken
```
public Storagetransfer.TransferOperations.List setPageToken(String pageToken)
```
    The list page token.
  - set
```
public Storagetransfer.TransferOperations.List set(String parameterName,
                                                   Object value)
```
    Overrides:
    
    set in class StoragetransferRequest<ListOperationsResponse>

Class Storagetransfer.TransferOperations.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.storagetransfer.v1.StoragetransferRequest

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

getName

setName

getFilter

setFilter

getPageSize

setPageSize

getPageToken

setPageToken

set