Class TransferTypes.TransferJob.Builder (1.53.0) 

public static final class TransferTypes.TransferJob.Builder extends GeneratedMessageV3.Builder<TransferTypes.TransferJob.Builder> implements TransferTypes.TransferJobOrBuilder

This resource represents the configuration of a transfer job that runs periodically.

Protobuf type google.storagetransfer.v1.TransferJob

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TransferTypes.TransferJob.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TransferTypes.TransferJob.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TransferTypes.TransferJob.Builder
Overrides

build()

public TransferTypes.TransferJob build()
Returns
Type Description
TransferTypes.TransferJob

buildPartial()

public TransferTypes.TransferJob buildPartial()
Returns
Type Description
TransferTypes.TransferJob

clear()

public TransferTypes.TransferJob.Builder clear()
Returns
Type Description
TransferTypes.TransferJob.Builder
Overrides

clearCreationTime()

public TransferTypes.TransferJob.Builder clearCreationTime()

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
TransferTypes.TransferJob.Builder

clearDeletionTime()

public TransferTypes.TransferJob.Builder clearDeletionTime()

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
TransferTypes.TransferJob.Builder

clearDescription()

public TransferTypes.TransferJob.Builder clearDescription()

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

string description = 2;

Returns
Type Description
TransferTypes.TransferJob.Builder

This builder for chaining.

clearEventStream()

public TransferTypes.TransferJob.Builder clearEventStream()

Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.

.google.storagetransfer.v1.EventStream event_stream = 15;

Returns
Type Description
TransferTypes.TransferJob.Builder

clearField(Descriptors.FieldDescriptor field)

public TransferTypes.TransferJob.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TransferTypes.TransferJob.Builder
Overrides

clearLastModificationTime()

public TransferTypes.TransferJob.Builder clearLastModificationTime()

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
TransferTypes.TransferJob.Builder

clearLatestOperationName()

public TransferTypes.TransferJob.Builder clearLatestOperationName()

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
TransferTypes.TransferJob.Builder

This builder for chaining.

clearLoggingConfig()

public TransferTypes.TransferJob.Builder clearLoggingConfig()

Logging configuration.

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

Returns
Type Description
TransferTypes.TransferJob.Builder

clearName()

public TransferTypes.TransferJob.Builder clearName()

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
TransferTypes.TransferJob.Builder

This builder for chaining.

clearNotificationConfig()

public TransferTypes.TransferJob.Builder clearNotificationConfig()

Notification configuration.

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

Returns
Type Description
TransferTypes.TransferJob.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public TransferTypes.TransferJob.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TransferTypes.TransferJob.Builder
Overrides

clearProjectId()

public TransferTypes.TransferJob.Builder clearProjectId()

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

string project_id = 3;

Returns
Type Description
TransferTypes.TransferJob.Builder

This builder for chaining.

clearSchedule()

public TransferTypes.TransferJob.Builder clearSchedule()

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.TransferJob.Builder

clearStatus()

public TransferTypes.TransferJob.Builder clearStatus()

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.Builder

This builder for chaining.

clearTransferSpec()

public TransferTypes.TransferJob.Builder clearTransferSpec()

Transfer specification.

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

Returns
Type Description
TransferTypes.TransferJob.Builder

clone()

public TransferTypes.TransferJob.Builder clone()
Returns
Type Description
TransferTypes.TransferJob.Builder
Overrides

getCreationTime()

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

getCreationTimeBuilder()

public Timestamp.Builder getCreationTimeBuilder()

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
Builder

getCreationTimeOrBuilder()

public 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

getDefaultInstanceForType()

public TransferTypes.TransferJob getDefaultInstanceForType()
Returns
Type Description
TransferTypes.TransferJob

getDeletionTime()

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

getDeletionTimeBuilder()

public Timestamp.Builder getDeletionTimeBuilder()

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
Builder

getDeletionTimeOrBuilder()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEventStream()

public TransferTypes.EventStream getEventStream()

Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.

.google.storagetransfer.v1.EventStream event_stream = 15;

Returns
Type Description
TransferTypes.EventStream

The eventStream.

getEventStreamBuilder()

public TransferTypes.EventStream.Builder getEventStreamBuilder()

Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.

.google.storagetransfer.v1.EventStream event_stream = 15;

Returns
Type Description
TransferTypes.EventStream.Builder

getEventStreamOrBuilder()

public TransferTypes.EventStreamOrBuilder getEventStreamOrBuilder()

Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.

.google.storagetransfer.v1.EventStream event_stream = 15;

Returns
Type Description
TransferTypes.EventStreamOrBuilder

getLastModificationTime()

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

getLastModificationTimeBuilder()

public Timestamp.Builder getLastModificationTimeBuilder()

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
Builder

getLastModificationTimeOrBuilder()

public 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 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 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 TransferTypes.LoggingConfig getLoggingConfig()

Logging configuration.

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

Returns
Type Description
TransferTypes.LoggingConfig

The loggingConfig.

getLoggingConfigBuilder()

public TransferTypes.LoggingConfig.Builder getLoggingConfigBuilder()

Logging configuration.

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

Returns
Type Description
TransferTypes.LoggingConfig.Builder

getLoggingConfigOrBuilder()

public TransferTypes.LoggingConfigOrBuilder getLoggingConfigOrBuilder()

Logging configuration.

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

Returns
Type Description
TransferTypes.LoggingConfigOrBuilder

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.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public 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 TransferTypes.NotificationConfig getNotificationConfig()

Notification configuration.

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

Returns
Type Description
TransferTypes.NotificationConfig

The notificationConfig.

getNotificationConfigBuilder()

public TransferTypes.NotificationConfig.Builder getNotificationConfigBuilder()

Notification configuration.

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

Returns
Type Description
TransferTypes.NotificationConfig.Builder

getNotificationConfigOrBuilder()

public TransferTypes.NotificationConfigOrBuilder getNotificationConfigOrBuilder()

Notification configuration.

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

Returns
Type Description
TransferTypes.NotificationConfigOrBuilder

getProjectId()

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

getScheduleBuilder()

public TransferTypes.Schedule.Builder getScheduleBuilder()

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.Builder

getScheduleOrBuilder()

public 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 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 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 TransferTypes.TransferSpec getTransferSpec()

Transfer specification.

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

Returns
Type Description
TransferTypes.TransferSpec

The transferSpec.

getTransferSpecBuilder()

public TransferTypes.TransferSpec.Builder getTransferSpecBuilder()

Transfer specification.

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

Returns
Type Description
TransferTypes.TransferSpec.Builder

getTransferSpecOrBuilder()

public TransferTypes.TransferSpecOrBuilder getTransferSpecOrBuilder()

Transfer specification.

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

Returns
Type Description
TransferTypes.TransferSpecOrBuilder

hasCreationTime()

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

hasEventStream()

public boolean hasEventStream()

Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.

.google.storagetransfer.v1.EventStream event_stream = 15;

Returns
Type Description
boolean

Whether the eventStream field is set.

hasLastModificationTime()

public 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 boolean hasLoggingConfig()

Logging configuration.

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

Returns
Type Description
boolean

Whether the loggingConfig field is set.

hasNotificationConfig()

public boolean hasNotificationConfig()

Notification configuration.

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

Returns
Type Description
boolean

Whether the notificationConfig field is set.

hasSchedule()

public 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 boolean hasTransferSpec()

Transfer specification.

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

Returns
Type Description
boolean

Whether the transferSpec field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreationTime(Timestamp value)

public TransferTypes.TransferJob.Builder mergeCreationTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
TransferTypes.TransferJob.Builder

mergeDeletionTime(Timestamp value)

public TransferTypes.TransferJob.Builder mergeDeletionTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
TransferTypes.TransferJob.Builder

mergeEventStream(TransferTypes.EventStream value)

public TransferTypes.TransferJob.Builder mergeEventStream(TransferTypes.EventStream value)

Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.

.google.storagetransfer.v1.EventStream event_stream = 15;

Parameter
Name Description
value TransferTypes.EventStream
Returns
Type Description
TransferTypes.TransferJob.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TransferTypes.TransferJob.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.TransferJob.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TransferTypes.TransferJob.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TransferTypes.TransferJob.Builder
Overrides

mergeFrom(TransferTypes.TransferJob other)

public TransferTypes.TransferJob.Builder mergeFrom(TransferTypes.TransferJob other)
Parameter
Name Description
other TransferTypes.TransferJob
Returns
Type Description
TransferTypes.TransferJob.Builder

mergeLastModificationTime(Timestamp value)

public TransferTypes.TransferJob.Builder mergeLastModificationTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
TransferTypes.TransferJob.Builder

mergeLoggingConfig(TransferTypes.LoggingConfig value)

public TransferTypes.TransferJob.Builder mergeLoggingConfig(TransferTypes.LoggingConfig value)

Logging configuration.

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

Parameter
Name Description
value TransferTypes.LoggingConfig
Returns
Type Description
TransferTypes.TransferJob.Builder

mergeNotificationConfig(TransferTypes.NotificationConfig value)

public TransferTypes.TransferJob.Builder mergeNotificationConfig(TransferTypes.NotificationConfig value)

Notification configuration.

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

Parameter
Name Description
value TransferTypes.NotificationConfig
Returns
Type Description
TransferTypes.TransferJob.Builder

mergeSchedule(TransferTypes.Schedule value)

public TransferTypes.TransferJob.Builder mergeSchedule(TransferTypes.Schedule value)

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;

Parameter
Name Description
value TransferTypes.Schedule
Returns
Type Description
TransferTypes.TransferJob.Builder

mergeTransferSpec(TransferTypes.TransferSpec value)

public TransferTypes.TransferJob.Builder mergeTransferSpec(TransferTypes.TransferSpec value)

Transfer specification.

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

Parameter
Name Description
value TransferTypes.TransferSpec
Returns
Type Description
TransferTypes.TransferJob.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TransferTypes.TransferJob.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TransferTypes.TransferJob.Builder
Overrides

setCreationTime(Timestamp value)

public TransferTypes.TransferJob.Builder setCreationTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
TransferTypes.TransferJob.Builder

setCreationTime(Timestamp.Builder builderForValue)

public TransferTypes.TransferJob.Builder setCreationTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
TransferTypes.TransferJob.Builder

setDeletionTime(Timestamp value)

public TransferTypes.TransferJob.Builder setDeletionTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
TransferTypes.TransferJob.Builder

setDeletionTime(Timestamp.Builder builderForValue)

public TransferTypes.TransferJob.Builder setDeletionTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
TransferTypes.TransferJob.Builder

setDescription(String value)

public TransferTypes.TransferJob.Builder setDescription(String value)

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

string description = 2;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
TransferTypes.TransferJob.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public TransferTypes.TransferJob.Builder setDescriptionBytes(ByteString value)

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

string description = 2;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
TransferTypes.TransferJob.Builder

This builder for chaining.

setEventStream(TransferTypes.EventStream value)

public TransferTypes.TransferJob.Builder setEventStream(TransferTypes.EventStream value)

Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.

.google.storagetransfer.v1.EventStream event_stream = 15;

Parameter
Name Description
value TransferTypes.EventStream
Returns
Type Description
TransferTypes.TransferJob.Builder

setEventStream(TransferTypes.EventStream.Builder builderForValue)

public TransferTypes.TransferJob.Builder setEventStream(TransferTypes.EventStream.Builder builderForValue)

Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.

.google.storagetransfer.v1.EventStream event_stream = 15;

Parameter
Name Description
builderForValue TransferTypes.EventStream.Builder
Returns
Type Description
TransferTypes.TransferJob.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public TransferTypes.TransferJob.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TransferTypes.TransferJob.Builder
Overrides

setLastModificationTime(Timestamp value)

public TransferTypes.TransferJob.Builder setLastModificationTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
TransferTypes.TransferJob.Builder

setLastModificationTime(Timestamp.Builder builderForValue)

public TransferTypes.TransferJob.Builder setLastModificationTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
TransferTypes.TransferJob.Builder

setLatestOperationName(String value)

public TransferTypes.TransferJob.Builder setLatestOperationName(String value)

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;

Parameter
Name Description
value String

The latestOperationName to set.
Returns
Type Description
TransferTypes.TransferJob.Builder

This builder for chaining.

setLatestOperationNameBytes(ByteString value)

public TransferTypes.TransferJob.Builder setLatestOperationNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for latestOperationName to set.
Returns
Type Description
TransferTypes.TransferJob.Builder

This builder for chaining.

setLoggingConfig(TransferTypes.LoggingConfig value)

public TransferTypes.TransferJob.Builder setLoggingConfig(TransferTypes.LoggingConfig value)

Logging configuration.

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

Parameter
Name Description
value TransferTypes.LoggingConfig
Returns
Type Description
TransferTypes.TransferJob.Builder

setLoggingConfig(TransferTypes.LoggingConfig.Builder builderForValue)

public TransferTypes.TransferJob.Builder setLoggingConfig(TransferTypes.LoggingConfig.Builder builderForValue)

Logging configuration.

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

Parameter
Name Description
builderForValue TransferTypes.LoggingConfig.Builder
Returns
Type Description
TransferTypes.TransferJob.Builder

setName(String value)

public TransferTypes.TransferJob.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
TransferTypes.TransferJob.Builder

This builder for chaining.

setNameBytes(ByteString value)

public TransferTypes.TransferJob.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
TransferTypes.TransferJob.Builder

This builder for chaining.

setNotificationConfig(TransferTypes.NotificationConfig value)

public TransferTypes.TransferJob.Builder setNotificationConfig(TransferTypes.NotificationConfig value)

Notification configuration.

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

Parameter
Name Description
value TransferTypes.NotificationConfig
Returns
Type Description
TransferTypes.TransferJob.Builder

setNotificationConfig(TransferTypes.NotificationConfig.Builder builderForValue)

public TransferTypes.TransferJob.Builder setNotificationConfig(TransferTypes.NotificationConfig.Builder builderForValue)

Notification configuration.

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

Parameter
Name Description
builderForValue TransferTypes.NotificationConfig.Builder
Returns
Type Description
TransferTypes.TransferJob.Builder

setProjectId(String value)

public TransferTypes.TransferJob.Builder setProjectId(String value)

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

string project_id = 3;

Parameter
Name Description
value String

The projectId to set.
Returns
Type Description
TransferTypes.TransferJob.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

public TransferTypes.TransferJob.Builder setProjectIdBytes(ByteString value)

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

string project_id = 3;

Parameter
Name Description
value ByteString

The bytes for projectId to set.
Returns
Type Description
TransferTypes.TransferJob.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TransferTypes.TransferJob.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TransferTypes.TransferJob.Builder
Overrides

setSchedule(TransferTypes.Schedule value)

public TransferTypes.TransferJob.Builder setSchedule(TransferTypes.Schedule value)

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;

Parameter
Name Description
value TransferTypes.Schedule
Returns
Type Description
TransferTypes.TransferJob.Builder

setSchedule(TransferTypes.Schedule.Builder builderForValue)

public TransferTypes.TransferJob.Builder setSchedule(TransferTypes.Schedule.Builder builderForValue)

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;

Parameter
Name Description
builderForValue TransferTypes.Schedule.Builder
Returns
Type Description
TransferTypes.TransferJob.Builder

setStatus(TransferTypes.TransferJob.Status value)

public TransferTypes.TransferJob.Builder setStatus(TransferTypes.TransferJob.Status value)

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;

Parameter
Name Description
value TransferTypes.TransferJob.Status

The status to set.
Returns
Type Description
TransferTypes.TransferJob.Builder

This builder for chaining.

setStatusValue(int value)

public TransferTypes.TransferJob.Builder setStatusValue(int value)

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;

Parameter
Name Description
value int

The enum numeric value on the wire for status to set.
Returns
Type Description
TransferTypes.TransferJob.Builder

This builder for chaining.

setTransferSpec(TransferTypes.TransferSpec value)

public TransferTypes.TransferJob.Builder setTransferSpec(TransferTypes.TransferSpec value)

Transfer specification.

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

Parameter
Name Description
value TransferTypes.TransferSpec
Returns
Type Description
TransferTypes.TransferJob.Builder

setTransferSpec(TransferTypes.TransferSpec.Builder builderForValue)

public TransferTypes.TransferJob.Builder setTransferSpec(TransferTypes.TransferSpec.Builder builderForValue)

Transfer specification.

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

Parameter
Name Description
builderForValue TransferTypes.TransferSpec.Builder
Returns
Type Description
TransferTypes.TransferJob.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final TransferTypes.TransferJob.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TransferTypes.TransferJob.Builder
Overrides