CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List (Database Migration API v1beta1-rev20201229-1.31.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.datamigration.v1beta1.CloudDatabaseMigrationServiceRequest<ListMigrationJobsResponse>
        
        com.google.api.services.datamigration.v1beta1.CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List

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

Enclosing class:: CloudDatabaseMigrationService.Projects.Locations.MigrationJobs

public class CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List
extends CloudDatabaseMigrationServiceRequest<ListMigrationJobsResponse>

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  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
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected List(String parent)
Lists migration jobs in a given project and location.

Constructors
Modifier	Constructor and Description
`protected`	`List(String parent)` Lists migration jobs in a given project and location.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`String`	`getFilter()` A filter expression that filters migration jobs listed in the response.
`String`	`getOrderBy()` Sort the results based on the migration job name.
`Integer`	`getPageSize()` The maximum number of migration jobs to return.
`String`	`getPageToken()` The nextPageToken value received in the previous call to migrationJobs.list, used in the subsequent request to retrieve the next page of results.
`String`	`getParent()` Required.
`CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List`	`set(String parameterName, Object value)`
`CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List`	`setAccessToken(String accessToken)` OAuth access token.
`CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List`	`setAlt(String alt)` Data format for response.
`CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List`	`setCallback(String callback)` JSONP
`CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List`	`setFilter(String filter)` A filter expression that filters migration jobs listed in the response.
`CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List`	`setKey(String key)` API key.
`CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List`	`setOrderBy(String orderBy)` Sort the results based on the migration job name.
`CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List`	`setPageSize(Integer pageSize)` The maximum number of migration jobs to return.
`CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List`	`setPageToken(String pageToken)` The nextPageToken value received in the previous call to migrationJobs.list, used in the subsequent request to retrieve the next page of results.
`CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List`	`setParent(String parent)` Required.
`CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.datamigration.v1beta1.CloudDatabaseMigrationServiceRequest
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.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 migration jobs in a given project and location. Create a request for the method "migrationJobs.list". This request holds the parameters needed by the the datamigration server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    CloudDatabaseMigrationService.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    parent - Required. The parent, which owns this collection of migrationJobs.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<ListMigrationJobsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListMigrationJobsResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List set$Xgafv(String $Xgafv)
```
    Description copied from class: CloudDatabaseMigrationServiceRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class CloudDatabaseMigrationServiceRequest<ListMigrationJobsResponse>
  - setAccessToken
```
public CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List setAccessToken(String accessToken)
```
    Description copied from class: CloudDatabaseMigrationServiceRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class CloudDatabaseMigrationServiceRequest<ListMigrationJobsResponse>
  - setAlt
```
public CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List setAlt(String alt)
```
    Description copied from class: CloudDatabaseMigrationServiceRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class CloudDatabaseMigrationServiceRequest<ListMigrationJobsResponse>
  - setCallback
```
public CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List setCallback(String callback)
```
    Description copied from class: CloudDatabaseMigrationServiceRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class CloudDatabaseMigrationServiceRequest<ListMigrationJobsResponse>
  - setFields
```
public CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List setFields(String fields)
```
    Description copied from class: CloudDatabaseMigrationServiceRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class CloudDatabaseMigrationServiceRequest<ListMigrationJobsResponse>
  - setKey
```
public CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List setKey(String key)
```
    Description copied from class: CloudDatabaseMigrationServiceRequest
    
    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 CloudDatabaseMigrationServiceRequest<ListMigrationJobsResponse>
  - setOauthToken
```
public CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List setOauthToken(String oauthToken)
```
    Description copied from class: CloudDatabaseMigrationServiceRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class CloudDatabaseMigrationServiceRequest<ListMigrationJobsResponse>
  - setPrettyPrint
```
public CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: CloudDatabaseMigrationServiceRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class CloudDatabaseMigrationServiceRequest<ListMigrationJobsResponse>
  - setQuotaUser
```
public CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List setQuotaUser(String quotaUser)
```
    Description copied from class: CloudDatabaseMigrationServiceRequest
    
    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 CloudDatabaseMigrationServiceRequest<ListMigrationJobsResponse>
  - setUploadType
```
public CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List setUploadType(String uploadType)
```
    Description copied from class: CloudDatabaseMigrationServiceRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class CloudDatabaseMigrationServiceRequest<ListMigrationJobsResponse>
  - setUploadProtocol
```
public CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: CloudDatabaseMigrationServiceRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class CloudDatabaseMigrationServiceRequest<ListMigrationJobsResponse>
  - getParent
```
public String getParent()
```
    Required. The parent, which owns this collection of migrationJobs.
  - setParent
```
public CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List setParent(String parent)
```
    Required. The parent, which owns this collection of migrationJobs.
  - getFilter
```
public String getFilter()
```
    A filter expression that filters migration jobs listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list migration jobs created this year by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.** You can also filter nested fields. For example, you could specify reverseSshConnectivity.vmIp = "1.2.3.4"** to select all migration jobs connecting through the specific SSH tunnel bastion.
  - setFilter
```
public CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List setFilter(String filter)
```
    A filter expression that filters migration jobs listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list migration jobs created this year by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.** You can also filter nested fields. For example, you could specify **reverseSshConnectivity.vmIp = "1.2.3.4"** to select all migration jobs connecting through the specific SSH tunnel bastion.
  - getOrderBy
```
public String getOrderBy()
```
    Sort the results based on the migration job name. Valid values are: "name", "name asc", and "name desc".
  - setOrderBy
```
public CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List setOrderBy(String orderBy)
```
    Sort the results based on the migration job name. Valid values are: "name", "name asc", and "name desc".
  - getPageSize
```
public Integer getPageSize()
```
    The maximum number of migration jobs to return. The service may return fewer than this value. If unspecified, at most 50 migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  - setPageSize
```
public CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List setPageSize(Integer pageSize)
```
    The maximum number of migration jobs to return. The service may return fewer than this value. If unspecified, at most 50 migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  - getPageToken
```
public String getPageToken()
```
    The nextPageToken value received in the previous call to migrationJobs.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to migrationJobs.list must match the call that provided the page token.
  - setPageToken
```
public CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List setPageToken(String pageToken)
```
    The nextPageToken value received in the previous call to migrationJobs.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to migrationJobs.list must match the call that provided the page token.
  - set
```
public CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.List set(String parameterName,
                                                                               Object value)
```
    Overrides:
    
    set in class CloudDatabaseMigrationServiceRequest<ListMigrationJobsResponse>

Class CloudDatabaseMigrationService.Projects.Locations.MigrationJobs.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.datamigration.v1beta1.CloudDatabaseMigrationServiceRequest

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

getOrderBy

setOrderBy

getPageSize

setPageSize

getPageToken

setPageToken

set