MigrationJob (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.json.GenericJson
    - - com.google.api.services.datamigration.v1beta1.model.MigrationJob

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class MigrationJob
extends GenericJson
```
Represents a Database Migration Service migration job object.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Database Migration API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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>

Constructor Summary

Constructors
Constructor and Description

MigrationJob()

Constructors
Constructor and Description
`MigrationJob()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MigrationJob`	`clone()`
`String`	`getCreateTime()` Output only.
`String`	`getDestination()` Required.
`DatabaseType`	`getDestinationDatabase()` The database engine type and provider of the destination.
`String`	`getDisplayName()` The migration job display name.
`String`	`getDumpPath()` The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]).
`String`	`getDuration()` Output only.
`String`	`getEndTime()` Output only.
`Status`	`getError()` Output only.
`Map<String,String>`	`getLabels()` The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs.
`String`	`getName()` The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/instances/{instance}.
`String`	`getPhase()` Output only.
`ReverseSshConnectivity`	`getReverseSshConnectivity()` The details needed to communicate to the source over Reverse SSH tunnel connectivity.
`String`	`getSource()` Required.
`DatabaseType`	`getSourceDatabase()` The database engine type and provider of the source.
`String`	`getState()` The current migration job state.
`StaticIpConnectivity`	`getStaticIpConnectivity()` static ip connectivity data (default, no additional details needed).
`String`	`getType()` Required.
`String`	`getUpdateTime()` Output only.
`VpcPeeringConnectivity`	`getVpcPeeringConnectivity()` The details of the VPC network that the source database is located in.
`MigrationJob`	`set(String fieldName, Object value)`
`MigrationJob`	`setCreateTime(String createTime)` Output only.
`MigrationJob`	`setDestination(String destination)` Required.
`MigrationJob`	`setDestinationDatabase(DatabaseType destinationDatabase)` The database engine type and provider of the destination.
`MigrationJob`	`setDisplayName(String displayName)` The migration job display name.
`MigrationJob`	`setDumpPath(String dumpPath)` The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]).
`MigrationJob`	`setDuration(String duration)` Output only.
`MigrationJob`	`setEndTime(String endTime)` Output only.
`MigrationJob`	`setError(Status error)` Output only.
`MigrationJob`	`setLabels(Map<String,String> labels)` The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs.
`MigrationJob`	`setName(String name)` The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/instances/{instance}.
`MigrationJob`	`setPhase(String phase)` Output only.
`MigrationJob`	`setReverseSshConnectivity(ReverseSshConnectivity reverseSshConnectivity)` The details needed to communicate to the source over Reverse SSH tunnel connectivity.
`MigrationJob`	`setSource(String source)` Required.
`MigrationJob`	`setSourceDatabase(DatabaseType sourceDatabase)` The database engine type and provider of the source.
`MigrationJob`	`setState(String state)` The current migration job state.
`MigrationJob`	`setStaticIpConnectivity(StaticIpConnectivity staticIpConnectivity)` static ip connectivity data (default, no additional details needed).
`MigrationJob`	`setType(String type)` Required.
`MigrationJob`	`setUpdateTime(String updateTime)` Output only.
`MigrationJob`	`setVpcPeeringConnectivity(VpcPeeringConnectivity vpcPeeringConnectivity)` The details of the VPC network that the source database is located in.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

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

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
  - MigrationJob
```
public MigrationJob()
```
- Method Detail
  - getCreateTime
```
public String getCreateTime()
```
    Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public MigrationJob setCreateTime(String createTime)
```
    Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
    
    Parameters:
    
    createTime - createTime or null for none
  - getDestination
```
public String getDestination()
```
    Required. The resource name (URI) of the destination connection profile.
    
    Returns:
    
    value or null for none
  - setDestination
```
public MigrationJob setDestination(String destination)
```
    Required. The resource name (URI) of the destination connection profile.
    
    Parameters:
    
    destination - destination or null for none
  - getDestinationDatabase
```
public DatabaseType getDestinationDatabase()
```
    The database engine type and provider of the destination.
    
    Returns:
    
    value or null for none
  - setDestinationDatabase
```
public MigrationJob setDestinationDatabase(DatabaseType destinationDatabase)
```
    The database engine type and provider of the destination.
    
    Parameters:
    
    destinationDatabase - destinationDatabase or null for none
  - getDisplayName
```
public String getDisplayName()
```
    The migration job display name.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public MigrationJob setDisplayName(String displayName)
```
    The migration job display name.
    
    Parameters:
    
    displayName - displayName or null for none
  - getDumpPath
```
public String getDumpPath()
```
    The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]).
    
    Returns:
    
    value or null for none
  - setDumpPath
```
public MigrationJob setDumpPath(String dumpPath)
```
    The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]).
    
    Parameters:
    
    dumpPath - dumpPath or null for none
  - getDuration
```
public String getDuration()
```
    Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
    
    Returns:
    
    value or null for none
  - setDuration
```
public MigrationJob setDuration(String duration)
```
    Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
    
    Parameters:
    
    duration - duration or null for none
  - getEndTime
```
public String getEndTime()
```
    Output only. If the migration job is completed, the time when it was completed.
    
    Returns:
    
    value or null for none
  - setEndTime
```
public MigrationJob setEndTime(String endTime)
```
    Output only. If the migration job is completed, the time when it was completed.
    
    Parameters:
    
    endTime - endTime or null for none
  - getError
```
public Status getError()
```
    Output only. The error details in case of state FAILED.
    
    Returns:
    
    value or null for none
  - setError
```
public MigrationJob setError(Status error)
```
    Output only. The error details in case of state FAILED.
    
    Parameters:
    
    error - error or null for none
  - getLabels
```
public Map<String,String> getLabels()
```
    The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
    
    Returns:
    
    value or null for none
  - setLabels
```
public MigrationJob setLabels(Map<String,String> labels)
```
    The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
    
    Parameters:
    
    labels - labels or null for none
  - getName
```
public String getName()
```
    The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/instances/{instance}.
    
    Returns:
    
    value or null for none
  - setName
```
public MigrationJob setName(String name)
```
    The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/instances/{instance}.
    
    Parameters:
    
    name - name or null for none
  - getPhase
```
public String getPhase()
```
    Output only. The current migration job phase.
    
    Returns:
    
    value or null for none
  - setPhase
```
public MigrationJob setPhase(String phase)
```
    Output only. The current migration job phase.
    
    Parameters:
    
    phase - phase or null for none
  - getReverseSshConnectivity
```
public ReverseSshConnectivity getReverseSshConnectivity()
```
    The details needed to communicate to the source over Reverse SSH tunnel connectivity.
    
    Returns:
    
    value or null for none
  - setReverseSshConnectivity
```
public MigrationJob setReverseSshConnectivity(ReverseSshConnectivity reverseSshConnectivity)
```
    The details needed to communicate to the source over Reverse SSH tunnel connectivity.
    
    Parameters:
    
    reverseSshConnectivity - reverseSshConnectivity or null for none
  - getSource
```
public String getSource()
```
    Required. The resource name (URI) of the source connection profile.
    
    Returns:
    
    value or null for none
  - setSource
```
public MigrationJob setSource(String source)
```
    Required. The resource name (URI) of the source connection profile.
    
    Parameters:
    
    source - source or null for none
  - getSourceDatabase
```
public DatabaseType getSourceDatabase()
```
    The database engine type and provider of the source.
    
    Returns:
    
    value or null for none
  - setSourceDatabase
```
public MigrationJob setSourceDatabase(DatabaseType sourceDatabase)
```
    The database engine type and provider of the source.
    
    Parameters:
    
    sourceDatabase - sourceDatabase or null for none
  - getState
```
public String getState()
```
    The current migration job state.
    
    Returns:
    
    value or null for none
  - setState
```
public MigrationJob setState(String state)
```
    The current migration job state.
    
    Parameters:
    
    state - state or null for none
  - getStaticIpConnectivity
```
public StaticIpConnectivity getStaticIpConnectivity()
```
    static ip connectivity data (default, no additional details needed).
    
    Returns:
    
    value or null for none
  - setStaticIpConnectivity
```
public MigrationJob setStaticIpConnectivity(StaticIpConnectivity staticIpConnectivity)
```
    static ip connectivity data (default, no additional details needed).
    
    Parameters:
    
    staticIpConnectivity - staticIpConnectivity or null for none
  - getType
```
public String getType()
```
    Required. The migration job type.
    
    Returns:
    
    value or null for none
  - setType
```
public MigrationJob setType(String type)
```
    Required. The migration job type.
    
    Parameters:
    
    type - type or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public MigrationJob setUpdateTime(String updateTime)
```
    Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
    
    Parameters:
    
    updateTime - updateTime or null for none
  - getVpcPeeringConnectivity
```
public VpcPeeringConnectivity getVpcPeeringConnectivity()
```
    The details of the VPC network that the source database is located in.
    
    Returns:
    
    value or null for none
  - setVpcPeeringConnectivity
```
public MigrationJob setVpcPeeringConnectivity(VpcPeeringConnectivity vpcPeeringConnectivity)
```
    The details of the VPC network that the source database is located in.
    
    Parameters:
    
    vpcPeeringConnectivity - vpcPeeringConnectivity or null for none
  - set
```
public MigrationJob set(String fieldName,
                        Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public MigrationJob clone()
```
    Overrides:
    
    clone in class GenericJson

Class MigrationJob

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

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

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

MigrationJob

Method Detail

getCreateTime

setCreateTime

getDestination

setDestination

getDestinationDatabase

setDestinationDatabase

getDisplayName

setDisplayName

getDumpPath

setDumpPath

getDuration

setDuration

getEndTime

setEndTime

getError

setError

getLabels

setLabels

getName

setName

getPhase

setPhase

getReverseSshConnectivity

setReverseSshConnectivity

getSource

setSource

getSourceDatabase

setSourceDatabase

getState

setState

getStaticIpConnectivity

setStaticIpConnectivity

getType

setType

getUpdateTime

setUpdateTime

getVpcPeeringConnectivity

setVpcPeeringConnectivity

set

clone