Interface TransferTypes.TransferJobOrBuilder (1.6.0)

Version 1.6.0

• 1.53.0 (latest)
• 1.52.0
• 1.51.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.0.4

public static interface TransferTypes.TransferJobOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCreationTime()

public abstract Timestamp getCreationTime()

Output only. The time that the transfer job was created.

.google.protobuf.Timestamp creation_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Timestamp	The creationTime.

getCreationTimeOrBuilder()

public abstract TimestampOrBuilder getCreationTimeOrBuilder()

Output only. The time that the transfer job was created.

.google.protobuf.Timestamp creation_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
TimestampOrBuilder

getDeletionTime()

public abstract Timestamp getDeletionTime()

Output only. The time that the transfer job was deleted.

.google.protobuf.Timestamp deletion_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Timestamp	The deletionTime.

getDeletionTimeOrBuilder()

public abstract TimestampOrBuilder getDeletionTimeOrBuilder()

Output only. The time that the transfer job was deleted.

.google.protobuf.Timestamp deletion_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
TimestampOrBuilder

getDescription()

public abstract String getDescription()

A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.

string description = 2;

Returns

Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.

string description = 2;

Returns

Type	Description
ByteString	The bytes for description.

getLastModificationTime()

public abstract Timestamp getLastModificationTime()

Output only. The time that the transfer job was last modified.

.google.protobuf.Timestamp last_modification_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Timestamp	The lastModificationTime.

getLastModificationTimeOrBuilder()

public abstract TimestampOrBuilder getLastModificationTimeOrBuilder()

Output only. The time that the transfer job was last modified.

.google.protobuf.Timestamp last_modification_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
TimestampOrBuilder

getLatestOperationName()

public abstract String getLatestOperationName()

The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.

string latest_operation_name = 12;

Returns

Type	Description
String	The latestOperationName.

getLatestOperationNameBytes()

public abstract ByteString getLatestOperationNameBytes()

The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.

string latest_operation_name = 12;

Returns

Type	Description
ByteString	The bytes for latestOperationName.

getLoggingConfig()

public abstract TransferTypes.LoggingConfig getLoggingConfig()

Logging configuration.

.google.storagetransfer.v1.LoggingConfig logging_config = 14;

Returns

Type	Description
TransferTypes.LoggingConfig	The loggingConfig.

getLoggingConfigOrBuilder()

public abstract TransferTypes.LoggingConfigOrBuilder getLoggingConfigOrBuilder()

Logging configuration.

.google.storagetransfer.v1.LoggingConfig logging_config = 14;

Returns

Type	Description
TransferTypes.LoggingConfigOrBuilder

getName()

public abstract 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.

string name = 1;

Returns

Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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.

string name = 1;

Returns

Type	Description
ByteString	The bytes for name.

getNotificationConfig()

public abstract TransferTypes.NotificationConfig getNotificationConfig()

Notification configuration. This is not supported for transfers involving PosixFilesystem.

.google.storagetransfer.v1.NotificationConfig notification_config = 11;

Returns

Type	Description
TransferTypes.NotificationConfig	The notificationConfig.

getNotificationConfigOrBuilder()

public abstract TransferTypes.NotificationConfigOrBuilder getNotificationConfigOrBuilder()

Notification configuration. This is not supported for transfers involving PosixFilesystem.

.google.storagetransfer.v1.NotificationConfig notification_config = 11;

Returns

Type	Description
TransferTypes.NotificationConfigOrBuilder

getProjectId()

public abstract String getProjectId()

The ID of the Google Cloud project that owns the job.

string project_id = 3;

Returns

Type	Description
String	The projectId.

getProjectIdBytes()

public abstract ByteString getProjectIdBytes()

The ID of the Google Cloud project that owns the job.

string project_id = 3;

Returns

Type	Description
ByteString	The bytes for projectId.

getSchedule()

public abstract TransferTypes.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.

.google.storagetransfer.v1.Schedule schedule = 5;

Returns

Type	Description
TransferTypes.Schedule	The schedule.

getScheduleOrBuilder()

public abstract TransferTypes.ScheduleOrBuilder getScheduleOrBuilder()

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.

.google.storagetransfer.v1.Schedule schedule = 5;

Returns

Type	Description
TransferTypes.ScheduleOrBuilder

getStatus()

public abstract TransferTypes.TransferJob.Status 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.

.google.storagetransfer.v1.TransferJob.Status status = 6;

Returns

Type	Description
TransferTypes.TransferJob.Status	The status.

getStatusValue()

public abstract int getStatusValue()

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.

.google.storagetransfer.v1.TransferJob.Status status = 6;

Returns

Type	Description
int	The enum numeric value on the wire for status.

getTransferSpec()

public abstract TransferTypes.TransferSpec getTransferSpec()

Transfer specification.

.google.storagetransfer.v1.TransferSpec transfer_spec = 4;

Returns

Type	Description
TransferTypes.TransferSpec	The transferSpec.

getTransferSpecOrBuilder()

public abstract TransferTypes.TransferSpecOrBuilder getTransferSpecOrBuilder()

Transfer specification.

.google.storagetransfer.v1.TransferSpec transfer_spec = 4;

Returns

Type	Description
TransferTypes.TransferSpecOrBuilder

hasCreationTime()

public abstract boolean hasCreationTime()

Output only. The time that the transfer job was created.

.google.protobuf.Timestamp creation_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the creationTime field is set.

hasDeletionTime()

public abstract boolean hasDeletionTime()

Output only. The time that the transfer job was deleted.

.google.protobuf.Timestamp deletion_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the deletionTime field is set.

hasLastModificationTime()

public abstract boolean hasLastModificationTime()

Output only. The time that the transfer job was last modified.

.google.protobuf.Timestamp last_modification_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the lastModificationTime field is set.

hasLoggingConfig()

public abstract boolean hasLoggingConfig()

Logging configuration.

.google.storagetransfer.v1.LoggingConfig logging_config = 14;

Returns

Type	Description
boolean	Whether the loggingConfig field is set.

hasNotificationConfig()

public abstract boolean hasNotificationConfig()

Notification configuration. This is not supported for transfers involving PosixFilesystem.

.google.storagetransfer.v1.NotificationConfig notification_config = 11;

Returns

Type	Description
boolean	Whether the notificationConfig field is set.

hasSchedule()

public abstract boolean hasSchedule()

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.

.google.storagetransfer.v1.Schedule schedule = 5;

Returns

Type	Description
boolean	Whether the schedule field is set.

hasTransferSpec()

public abstract boolean hasTransferSpec()

Transfer specification.

.google.storagetransfer.v1.TransferSpec transfer_spec = 4;

Returns

Type	Description
boolean	Whether the transferSpec field is set.