Spanner.Projects.Instances.BackupOperations.List (Cloud Spanner API v1-rev20250708-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.spanner.v1.SpannerRequest<ListBackupOperationsResponse>
        
        com.google.api.services.spanner.v1.Spanner.Projects.Instances.BackupOperations.List

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

Enclosing class:: Spanner.Projects.Instances.BackupOperations

public class Spanner.Projects.Instances.BackupOperations.List
extends SpannerRequest<ListBackupOperationsResponse>

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 parent)
Lists the backup long-running operations in the given instance.

Constructors
Modifier	Constructor and Description
`protected`	`List(String parent)` Lists the backup long-running operations in the given instance.

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()` An expression that filters the list of returned backup operations.
`Integer`	`getPageSize()` Number of operations to be returned in the response.
`String`	`getPageToken()` If non-empty, `page_token` should contain a next_page_token from a previous ListBackupOperationsResponse to the same `parent` and with the same `filter`.
`String`	`getParent()` Required.
`Spanner.Projects.Instances.BackupOperations.List`	`set(String parameterName, Object value)`
`Spanner.Projects.Instances.BackupOperations.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Spanner.Projects.Instances.BackupOperations.List`	`setAccessToken(String accessToken)` OAuth access token.
`Spanner.Projects.Instances.BackupOperations.List`	`setAlt(String alt)` Data format for response.
`Spanner.Projects.Instances.BackupOperations.List`	`setCallback(String callback)` JSONP
`Spanner.Projects.Instances.BackupOperations.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Spanner.Projects.Instances.BackupOperations.List`	`setFilter(String filter)` An expression that filters the list of returned backup operations.
`Spanner.Projects.Instances.BackupOperations.List`	`setKey(String key)` API key.
`Spanner.Projects.Instances.BackupOperations.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Spanner.Projects.Instances.BackupOperations.List`	`setPageSize(Integer pageSize)` Number of operations to be returned in the response.
`Spanner.Projects.Instances.BackupOperations.List`	`setPageToken(String pageToken)` If non-empty, `page_token` should contain a next_page_token from a previous ListBackupOperationsResponse to the same `parent` and with the same `filter`.
`Spanner.Projects.Instances.BackupOperations.List`	`setParent(String parent)` Required.
`Spanner.Projects.Instances.BackupOperations.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Spanner.Projects.Instances.BackupOperations.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Spanner.Projects.Instances.BackupOperations.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Spanner.Projects.Instances.BackupOperations.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.spanner.v1.SpannerRequest
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 parent)
```
    Lists the backup long-running operations in the given instance. A backup operation has a name of the form `projects//instances//backups//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.progress.start_time` in descending order starting from the most recently started operation. Create a request for the method "backupOperations.list". This request holds the parameters needed by the the spanner server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Spanner.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    parent - Required. The instance of the backup operations. Values are of the form `projects//instances/`.
    
    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<ListBackupOperationsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListBackupOperationsResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Spanner.Projects.Instances.BackupOperations.List set$Xgafv(String $Xgafv)
```
    Description copied from class: SpannerRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class SpannerRequest<ListBackupOperationsResponse>
  - setAccessToken
```
public Spanner.Projects.Instances.BackupOperations.List setAccessToken(String accessToken)
```
    Description copied from class: SpannerRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class SpannerRequest<ListBackupOperationsResponse>
  - setAlt
```
public Spanner.Projects.Instances.BackupOperations.List setAlt(String alt)
```
    Description copied from class: SpannerRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class SpannerRequest<ListBackupOperationsResponse>
  - setCallback
```
public Spanner.Projects.Instances.BackupOperations.List setCallback(String callback)
```
    Description copied from class: SpannerRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class SpannerRequest<ListBackupOperationsResponse>
  - setFields
```
public Spanner.Projects.Instances.BackupOperations.List setFields(String fields)
```
    Description copied from class: SpannerRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class SpannerRequest<ListBackupOperationsResponse>
  - setKey
```
public Spanner.Projects.Instances.BackupOperations.List setKey(String key)
```
    Description copied from class: SpannerRequest
    
    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 SpannerRequest<ListBackupOperationsResponse>
  - setOauthToken
```
public Spanner.Projects.Instances.BackupOperations.List setOauthToken(String oauthToken)
```
    Description copied from class: SpannerRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class SpannerRequest<ListBackupOperationsResponse>
  - setPrettyPrint
```
public Spanner.Projects.Instances.BackupOperations.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: SpannerRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class SpannerRequest<ListBackupOperationsResponse>
  - setQuotaUser
```
public Spanner.Projects.Instances.BackupOperations.List setQuotaUser(String quotaUser)
```
    Description copied from class: SpannerRequest
    
    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 SpannerRequest<ListBackupOperationsResponse>
  - setUploadType
```
public Spanner.Projects.Instances.BackupOperations.List setUploadType(String uploadType)
```
    Description copied from class: SpannerRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class SpannerRequest<ListBackupOperationsResponse>
  - setUploadProtocol
```
public Spanner.Projects.Instances.BackupOperations.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: SpannerRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class SpannerRequest<ListBackupOperationsResponse>
  - getParent
```
public String getParent()
```
    Required. The instance of the backup operations. Values are of the form `projects//instances/`.
  - setParent
```
public Spanner.Projects.Instances.BackupOperations.List setParent(String parent)
```
    Required. The instance of the backup operations. Values are of the form `projects//instances/`.
  - getFilter
```
public String getFilter()
```
    An expression that filters the list of returned backup operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateBackupMetadata is `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first if filtering on metadata fields. `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \ `metadata.database:prod` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The source database name of backup contains the string "prod". * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \ `(metadata.name:howl) AND` \ `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \ `(error:*)` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The backup name contains the string "howl". * The operation started before 2018-03-28T14:50:00Z. * The operation resulted in an error. * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \ `(metadata.source_backup:test) AND` \ `(metadata.progress.start_time < \"2022-01-18T14:50:00Z\") AND` \ `(error:*)` - Returns operations where: * The operation's metadata type is CopyBackupMetadata. * The source backup name contains the string "test". * The operation started before 2022-01-18T14:50:00Z. * The operation resulted in an error. * `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \ `(metadata.database:test_db)) OR` \ `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \ `(metadata.source_backup:test_bkp)) AND` \ `(error:*)` - Returns operations where: * The operation's metadata matches either of criteria: * The operation's metadata type is CreateBackupMetadata AND the source database name of the backup contains the string "test_db" * The operation's metadata type is CopyBackupMetadata AND the source backup name contains the string "test_bkp" * The operation resulted in an error.
  - setFilter
```
public Spanner.Projects.Instances.BackupOperations.List setFilter(String filter)
```
    An expression that filters the list of returned backup operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateBackupMetadata is `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=type.googleapis.com/google.spanner.admin.data base.v1.CreateBackupMetadata) AND` \ `metadata.database:prod` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The source database name of backup contains the string "prod". * `(metadata.@type=type.googleapis.com/googl e.spanner.admin.database.v1.CreateBackupMetadata) AND` \ `(metadata.name:howl) AND` \ `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \ `(error:*)` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The backup name contains the string "howl". * The operation started before 2018-03-28T14:50:00Z. * The operation resulted in an error. * `(metadata.@type=type.googleapis.com/google.spann er.admin.database.v1.CopyBackupMetadata) AND` \ `(metadata.source_backup:test) AND` \ `(metadata.progress.start_time < \"2022-01-18T14:50:00Z\") AND` \ `(error:*)` - Returns operations where: * The operation's metadata type is CopyBackupMetadata. * The source backup name contains the string "test". * The operation started before 2022-01-18T14:50:00Z. * The operation resulted in an error. * `((metadata.@type=type.go ogleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \ `(metadata.database:test_db)) OR` \ `((metadata.@type=type.googleapis.com/google.spanne r.admin.database.v1.CopyBackupMetadata) AND` \ `(metadata.source_backup:test_bkp)) AND` \ `(error:*)` - Returns operations where: * The operation's metadata matches either of criteria: * The operation's metadata type is CreateBackupMetadata AND the source database name of the backup contains the string "test_db" * The operation's metadata type is CopyBackupMetadata AND the source backup name contains the string "test_bkp" * The operation resulted in an error.
  - getPageSize
```
public Integer getPageSize()
```
    Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
  - setPageSize
```
public Spanner.Projects.Instances.BackupOperations.List setPageSize(Integer pageSize)
```
    Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
  - getPageToken
```
public String getPageToken()
```
    If non-empty, `page_token` should contain a next_page_token from a previous ListBackupOperationsResponse to the same `parent` and with the same `filter`.
  - setPageToken
```
public Spanner.Projects.Instances.BackupOperations.List setPageToken(String pageToken)
```
    If non-empty, `page_token` should contain a next_page_token from a previous ListBackupOperationsResponse to the same `parent` and with the same `filter`.
  - set
```
public Spanner.Projects.Instances.BackupOperations.List set(String parameterName,
                                                            Object value)
```
    Overrides:
    
    set in class SpannerRequest<ListBackupOperationsResponse>

Class Spanner.Projects.Instances.BackupOperations.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.spanner.v1.SpannerRequest

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

getParent

setParent

getFilter

setFilter

getPageSize

setPageSize

getPageToken

setPageToken

set