com.google.storagetransfer.v1.proto

Interface TransferTypes.TransferJobOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

TransferTypes.TransferJob, TransferTypes.TransferJob.Builder

Enclosing class:

TransferTypes

public static interface TransferTypes.TransferJobOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.Timestamp	getCreationTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreationTimeOrBuilder() Output only.
com.google.protobuf.Timestamp	getDeletionTime() Output only.
com.google.protobuf.TimestampOrBuilder	getDeletionTimeOrBuilder() Output only.
String	getDescription() A description provided by the user for the job.
com.google.protobuf.ByteString	getDescriptionBytes() A description provided by the user for the job.
com.google.protobuf.Timestamp	getLastModificationTime() Output only.
com.google.protobuf.TimestampOrBuilder	getLastModificationTimeOrBuilder() Output only.
String	getLatestOperationName() The name of the most recently started TransferOperation of this JobConfig.
com.google.protobuf.ByteString	getLatestOperationNameBytes() The name of the most recently started TransferOperation of this JobConfig.
TransferTypes.LoggingConfig	getLoggingConfig() Logging configuration.
TransferTypes.LoggingConfigOrBuilder	getLoggingConfigOrBuilder() Logging configuration.
String	getName() A unique name (within the transfer project) assigned when the job is created.
com.google.protobuf.ByteString	getNameBytes() A unique name (within the transfer project) assigned when the job is created.
TransferTypes.NotificationConfig	getNotificationConfig() Notification configuration.
TransferTypes.NotificationConfigOrBuilder	getNotificationConfigOrBuilder() Notification configuration.
String	getProjectId() The ID of the Google Cloud project that owns the job.
com.google.protobuf.ByteString	getProjectIdBytes() The ID of the Google Cloud project that owns the job.
TransferTypes.Schedule	getSchedule() Specifies schedule for the transfer job.
TransferTypes.ScheduleOrBuilder	getScheduleOrBuilder() Specifies schedule for the transfer job.
TransferTypes.TransferJob.Status	getStatus() Status of the job.
int	getStatusValue() Status of the job.
TransferTypes.TransferSpec	getTransferSpec() Transfer specification.
TransferTypes.TransferSpecOrBuilder	getTransferSpecOrBuilder() Transfer specification.
boolean	hasCreationTime() Output only.
boolean	hasDeletionTime() Output only.
boolean	hasLastModificationTime() Output only.
boolean	hasLoggingConfig() Logging configuration.
boolean	hasNotificationConfig() Notification configuration.
boolean	hasSchedule() Specifies schedule for the transfer job.
boolean	hasTransferSpec() Transfer specification.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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][google.rpc.Code.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][google.rpc.Code.INVALID_ARGUMENT] error.
 

string name = 1;

Returns:

The name.

getNameBytes

com.google.protobuf.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][google.rpc.Code.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][google.rpc.Code.INVALID_ARGUMENT] error.
 

string name = 1;

Returns:

The bytes for name.

getDescription

String getDescription()

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

string description = 2;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

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

string description = 2;

Returns:

The bytes for description.

getProjectId

String getProjectId()

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

string project_id = 3;

Returns:

The projectId.

getProjectIdBytes

com.google.protobuf.ByteString getProjectIdBytes()

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

string project_id = 3;

Returns:

The bytes for projectId.

hasTransferSpec

boolean hasTransferSpec()

 Transfer specification.
 

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

Returns:

Whether the transferSpec field is set.

getTransferSpec

TransferTypes.TransferSpec getTransferSpec()

 Transfer specification.
 

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

Returns:

The transferSpec.

getTransferSpecOrBuilder

TransferTypes.TransferSpecOrBuilder getTransferSpecOrBuilder()

 Transfer specification.
 

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

hasNotificationConfig

boolean hasNotificationConfig()

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

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

Returns:

Whether the notificationConfig field is set.

getNotificationConfig

TransferTypes.NotificationConfig getNotificationConfig()

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

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

Returns:

The notificationConfig.

getNotificationConfigOrBuilder

TransferTypes.NotificationConfigOrBuilder getNotificationConfigOrBuilder()

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

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

hasLoggingConfig

boolean hasLoggingConfig()

 Logging configuration.
 

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

Returns:

Whether the loggingConfig field is set.

getLoggingConfig

TransferTypes.LoggingConfig getLoggingConfig()

 Logging configuration.
 

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

Returns:

The loggingConfig.

getLoggingConfigOrBuilder

TransferTypes.LoggingConfigOrBuilder getLoggingConfigOrBuilder()

 Logging configuration.
 

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

hasSchedule

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:

Whether the schedule field is set.

getSchedule

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:

The schedule.

getScheduleOrBuilder

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;

getStatusValue

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][google.storagetransfer.v1.TransferJob.Status.ENABLED] to [DISABLED][google.storagetransfer.v1.TransferJob.Status.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:

The enum numeric value on the wire for status.

getStatus

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][google.storagetransfer.v1.TransferJob.Status.ENABLED] to [DISABLED][google.storagetransfer.v1.TransferJob.Status.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:

The status.

hasCreationTime

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:

Whether the creationTime field is set.

getCreationTime

com.google.protobuf.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:

The creationTime.

getCreationTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreationTimeOrBuilder()

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

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

hasLastModificationTime

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:

Whether the lastModificationTime field is set.

getLastModificationTime

com.google.protobuf.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:

The lastModificationTime.

getLastModificationTimeOrBuilder

com.google.protobuf.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];

hasDeletionTime

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:

Whether the deletionTime field is set.

getDeletionTime

com.google.protobuf.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:

The deletionTime.

getDeletionTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getDeletionTimeOrBuilder()

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

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

getLatestOperationName

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:

The latestOperationName.

getLatestOperationNameBytes

com.google.protobuf.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:

The bytes for latestOperationName.