TransferJob (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.json.GenericJson
    - - com.google.api.services.storagetransfer.v1.model.TransferJob

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class TransferJob
extends com.google.api.client.json.GenericJson
```
This resource represents the configuration of a transfer job that runs periodically.
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 Storage Transfer 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
  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>

Constructor Summary

Constructors
Constructor and Description

TransferJob()

Constructors
Constructor and Description
`TransferJob()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransferJob`	`clone()`
`String`	`getCreationTime()` Output only.
`String`	`getDeletionTime()` Output only.
`String`	`getDescription()` A description provided by the user for the job.
`EventStream`	`getEventStream()` Specifies the event stream for the transfer job for event-driven transfers.
`String`	`getLastModificationTime()` Output only.
`String`	`getLatestOperationName()` The name of the most recently started TransferOperation of this JobConfig.
`LoggingConfig`	`getLoggingConfig()` Logging configuration.
`String`	`getName()` A unique name (within the transfer project) assigned when the job is created.
`NotificationConfig`	`getNotificationConfig()` Notification configuration.
`String`	`getProjectId()` The ID of the Google Cloud project that owns the job.
`ReplicationSpec`	`getReplicationSpec()` Replication specification.
`Schedule`	`getSchedule()` Specifies schedule for the transfer job.
`String`	`getStatus()` Status of the job.
`TransferSpec`	`getTransferSpec()` Transfer specification.
`TransferJob`	`set(String fieldName, Object value)`
`TransferJob`	`setCreationTime(String creationTime)` Output only.
`TransferJob`	`setDeletionTime(String deletionTime)` Output only.
`TransferJob`	`setDescription(String description)` A description provided by the user for the job.
`TransferJob`	`setEventStream(EventStream eventStream)` Specifies the event stream for the transfer job for event-driven transfers.
`TransferJob`	`setLastModificationTime(String lastModificationTime)` Output only.
`TransferJob`	`setLatestOperationName(String latestOperationName)` The name of the most recently started TransferOperation of this JobConfig.
`TransferJob`	`setLoggingConfig(LoggingConfig loggingConfig)` Logging configuration.
`TransferJob`	`setName(String name)` A unique name (within the transfer project) assigned when the job is created.
`TransferJob`	`setNotificationConfig(NotificationConfig notificationConfig)` Notification configuration.
`TransferJob`	`setProjectId(String projectId)` The ID of the Google Cloud project that owns the job.
`TransferJob`	`setReplicationSpec(ReplicationSpec replicationSpec)` Replication specification.
`TransferJob`	`setSchedule(Schedule schedule)` Specifies schedule for the transfer job.
`TransferJob`	`setStatus(String status)` Status of the job.
`TransferJob`	`setTransferSpec(TransferSpec transferSpec)` Transfer specification.

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
  - TransferJob
```
public TransferJob()
```
- Method Detail
  - getCreationTime
```
public String getCreationTime()
```
    Output only. The time that the transfer job was created.
    
    Returns:
    
    value or null for none
  - setCreationTime
```
public TransferJob setCreationTime(String creationTime)
```
    Output only. The time that the transfer job was created.
    
    Parameters:
    
    creationTime - creationTime or null for none
  - getDeletionTime
```
public String getDeletionTime()
```
    Output only. The time that the transfer job was deleted.
    
    Returns:
    
    value or null for none
  - setDeletionTime
```
public TransferJob setDeletionTime(String deletionTime)
```
    Output only. The time that the transfer job was deleted.
    
    Parameters:
    
    deletionTime - deletionTime or null for none
  - getDescription
```
public String getDescription()
```
    A description provided by the user for the job. Its max length is 1024 bytes when Unicode- encoded.
    
    Returns:
    
    value or null for none
  - setDescription
```
public TransferJob setDescription(String description)
```
    A description provided by the user for the job. Its max length is 1024 bytes when Unicode- encoded.
    
    Parameters:
    
    description - description or null for none
  - getEventStream
```
public EventStream getEventStream()
```
    Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.
    
    Returns:
    
    value or null for none
  - setEventStream
```
public TransferJob setEventStream(EventStream eventStream)
```
    Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.
    
    Parameters:
    
    eventStream - eventStream or null for none
  - getLastModificationTime
```
public String getLastModificationTime()
```
    Output only. The time that the transfer job was last modified.
    
    Returns:
    
    value or null for none
  - setLastModificationTime
```
public TransferJob setLastModificationTime(String lastModificationTime)
```
    Output only. The time that the transfer job was last modified.
    
    Parameters:
    
    lastModificationTime - lastModificationTime or null for none
  - getLatestOperationName
```
public String getLatestOperationName()
```
    The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
    
    Returns:
    
    value or null for none
  - setLatestOperationName
```
public TransferJob setLatestOperationName(String latestOperationName)
```
    The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
    
    Parameters:
    
    latestOperationName - latestOperationName or null for none
  - getLoggingConfig
```
public LoggingConfig getLoggingConfig()
```
    Logging configuration.
    
    Returns:
    
    value or null for none
  - setLoggingConfig
```
public TransferJob setLoggingConfig(LoggingConfig loggingConfig)
```
    Logging configuration.
    
    Parameters:
    
    loggingConfig - loggingConfig or null for none
  - getName
```
public String getName()
```
    A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service assigns a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with `"transferJobs/"` prefix and end with a letter or a number, and should be no more than 128 characters. For transfers involving PosixFilesystem, this name must start with `transferJobs/OPI` specifically. For all other transfer types, this name must not start with `transferJobs/OPI`. Non-PosixFilesystem example: `"transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$"` PosixFilesystem example: `"transferJobs/OPI^[A-Za-z0-9-._~]*[A-Za-z0-9]$"` Applications must not rely on the enforcement of naming requirements involving OPI. Invalid job names fail with an INVALID_ARGUMENT error.
    
    Returns:
    
    value or null for none
  - setName
```
public TransferJob setName(String name)
```
    A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service assigns a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with `"transferJobs/"` prefix and end with a letter or a number, and should be no more than 128 characters. For transfers involving PosixFilesystem, this name must start with `transferJobs/OPI` specifically. For all other transfer types, this name must not start with `transferJobs/OPI`. Non-PosixFilesystem example: `"transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$"` PosixFilesystem example: `"transferJobs/OPI^[A-Za-z0-9-._~]*[A-Za-z0-9]$"` Applications must not rely on the enforcement of naming requirements involving OPI. Invalid job names fail with an INVALID_ARGUMENT error.
    
    Parameters:
    
    name - name or null for none
  - getNotificationConfig
```
public NotificationConfig getNotificationConfig()
```
    Notification configuration.
    
    Returns:
    
    value or null for none
  - setNotificationConfig
```
public TransferJob setNotificationConfig(NotificationConfig notificationConfig)
```
    Notification configuration.
    
    Parameters:
    
    notificationConfig - notificationConfig or null for none
  - getProjectId
```
public String getProjectId()
```
    The ID of the Google Cloud project that owns the job.
    
    Returns:
    
    value or null for none
  - setProjectId
```
public TransferJob setProjectId(String projectId)
```
    The ID of the Google Cloud project that owns the job.
    
    Parameters:
    
    projectId - projectId or null for none
  - getReplicationSpec
```
public ReplicationSpec getReplicationSpec()
```
    Replication specification.
    
    Returns:
    
    value or null for none
  - setReplicationSpec
```
public TransferJob setReplicationSpec(ReplicationSpec replicationSpec)
```
    Replication specification.
    
    Parameters:
    
    replicationSpec - replicationSpec or null for none
  - getSchedule
```
public Schedule getSchedule()
```
    Specifies schedule for the transfer job. This is an optional field. When the field is not set, the job never executes a transfer, unless you invoke RunTransferJob or update the job to have a non-empty schedule.
    
    Returns:
    
    value or null for none
  - setSchedule
```
public TransferJob setSchedule(Schedule schedule)
```
    Specifies schedule for the transfer job. This is an optional field. When the field is not set, the job never executes a transfer, unless you invoke RunTransferJob or update the job to have a non-empty schedule.
    
    Parameters:
    
    schedule - schedule or null for none
  - getStatus
```
public String getStatus()
```
    Status of the job. This value MUST be specified for `CreateTransferJobRequests`. **Note:** The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from ENABLED to DISABLED, and an operation spawned by the transfer is running, the status change would not affect the current operation.
    
    Returns:
    
    value or null for none
  - setStatus
```
public TransferJob setStatus(String status)
```
    Status of the job. This value MUST be specified for `CreateTransferJobRequests`. **Note:** The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from ENABLED to DISABLED, and an operation spawned by the transfer is running, the status change would not affect the current operation.
    
    Parameters:
    
    status - status or null for none
  - getTransferSpec
```
public TransferSpec getTransferSpec()
```
    Transfer specification.
    
    Returns:
    
    value or null for none
  - setTransferSpec
```
public TransferJob setTransferSpec(TransferSpec transferSpec)
```
    Transfer specification.
    
    Parameters:
    
    transferSpec - transferSpec or null for none
  - set
```
public TransferJob set(String fieldName,
                       Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public TransferJob clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class TransferJob

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

TransferJob

Method Detail

getCreationTime

setCreationTime

getDeletionTime

setDeletionTime

getDescription

setDescription

getEventStream

setEventStream

getLastModificationTime

setLastModificationTime

getLatestOperationName

setLatestOperationName

getLoggingConfig

setLoggingConfig

getName

setName

getNotificationConfig

setNotificationConfig

getProjectId

setProjectId

getReplicationSpec

setReplicationSpec

getSchedule

setSchedule

getStatus

setStatus

getTransferSpec

setTransferSpec

set

clone